Skip to content

Type definitions#

Index > DataExchange > Type definitions

Auto-generated documentation for DataExchange type annotations stubs module mypy-boto3-dataexchange.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ApiGatewayApiAssetTypeDef#

# ApiGatewayApiAssetTypeDef definition

class ApiGatewayApiAssetTypeDef(TypedDict):
    ApiDescription: NotRequired[str],
    ApiEndpoint: NotRequired[str],
    ApiId: NotRequired[str],
    ApiKey: NotRequired[str],
    ApiName: NotRequired[str],
    ApiSpecificationDownloadUrl: NotRequired[str],
    ApiSpecificationDownloadUrlExpiresAt: NotRequired[datetime],
    ProtocolType: NotRequired[ProtocolTypeType],  # (1)
    Stage: NotRequired[str],
  1. See ProtocolTypeType

AssetDestinationEntryTypeDef#

# AssetDestinationEntryTypeDef definition

class AssetDestinationEntryTypeDef(TypedDict):
    AssetId: str,
    Bucket: str,
    Key: NotRequired[str],

RedshiftDataShareAssetTypeDef#

# RedshiftDataShareAssetTypeDef definition

class RedshiftDataShareAssetTypeDef(TypedDict):
    Arn: str,

S3SnapshotAssetTypeDef#

# S3SnapshotAssetTypeDef definition

class S3SnapshotAssetTypeDef(TypedDict):
    Size: float,

AssetSourceEntryTypeDef#

# AssetSourceEntryTypeDef definition

class AssetSourceEntryTypeDef(TypedDict):
    Bucket: str,
    Key: str,

AutoExportRevisionDestinationEntryTypeDef#

# AutoExportRevisionDestinationEntryTypeDef definition

class AutoExportRevisionDestinationEntryTypeDef(TypedDict):
    Bucket: str,
    KeyPattern: NotRequired[str],

ExportServerSideEncryptionTypeDef#

# ExportServerSideEncryptionTypeDef definition

class ExportServerSideEncryptionTypeDef(TypedDict):
    Type: ServerSideEncryptionTypesType,  # (1)
    KmsKeyArn: NotRequired[str],
  1. See ServerSideEncryptionTypesType

CancelJobRequestRequestTypeDef#

# CancelJobRequestRequestTypeDef definition

class CancelJobRequestRequestTypeDef(TypedDict):
    JobId: str,

CreateDataSetRequestRequestTypeDef#

# CreateDataSetRequestRequestTypeDef definition

class CreateDataSetRequestRequestTypeDef(TypedDict):
    AssetType: AssetTypeType,  # (1)
    Description: str,
    Name: str,
    Tags: NotRequired[Mapping[str, str]],
  1. See AssetTypeType

OriginDetailsTypeDef#

# OriginDetailsTypeDef definition

class OriginDetailsTypeDef(TypedDict):
    ProductId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateRevisionRequestRequestTypeDef#

# CreateRevisionRequestRequestTypeDef definition

class CreateRevisionRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    Comment: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

LFTagPaginatorTypeDef#

# LFTagPaginatorTypeDef definition

class LFTagPaginatorTypeDef(TypedDict):
    TagKey: str,
    TagValues: List[str],

LFTagTypeDef#

# LFTagTypeDef definition

class LFTagTypeDef(TypedDict):
    TagKey: str,
    TagValues: Sequence[str],

DeleteAssetRequestRequestTypeDef#

# DeleteAssetRequestRequestTypeDef definition

class DeleteAssetRequestRequestTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    RevisionId: str,

DeleteDataSetRequestRequestTypeDef#

# DeleteDataSetRequestRequestTypeDef definition

class DeleteDataSetRequestRequestTypeDef(TypedDict):
    DataSetId: str,

DeleteEventActionRequestRequestTypeDef#

# DeleteEventActionRequestRequestTypeDef definition

class DeleteEventActionRequestRequestTypeDef(TypedDict):
    EventActionId: str,

DeleteRevisionRequestRequestTypeDef#

# DeleteRevisionRequestRequestTypeDef definition

class DeleteRevisionRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    RevisionId: str,

ImportAssetFromSignedUrlJobErrorDetailsTypeDef#

# ImportAssetFromSignedUrlJobErrorDetailsTypeDef definition

class ImportAssetFromSignedUrlJobErrorDetailsTypeDef(TypedDict):
    AssetName: str,

RevisionPublishedTypeDef#

# RevisionPublishedTypeDef definition

class RevisionPublishedTypeDef(TypedDict):
    DataSetId: str,

ExportAssetToSignedUrlRequestDetailsTypeDef#

# ExportAssetToSignedUrlRequestDetailsTypeDef definition

class ExportAssetToSignedUrlRequestDetailsTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    RevisionId: str,

ExportAssetToSignedUrlResponseDetailsTypeDef#

# ExportAssetToSignedUrlResponseDetailsTypeDef definition

class ExportAssetToSignedUrlResponseDetailsTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    RevisionId: str,
    SignedUrl: NotRequired[str],
    SignedUrlExpiresAt: NotRequired[datetime],

RevisionDestinationEntryTypeDef#

# RevisionDestinationEntryTypeDef definition

class RevisionDestinationEntryTypeDef(TypedDict):
    Bucket: str,
    RevisionId: str,
    KeyPattern: NotRequired[str],

GetAssetRequestRequestTypeDef#

# GetAssetRequestRequestTypeDef definition

class GetAssetRequestRequestTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    RevisionId: str,

GetDataSetRequestRequestTypeDef#

# GetDataSetRequestRequestTypeDef definition

class GetDataSetRequestRequestTypeDef(TypedDict):
    DataSetId: str,

GetEventActionRequestRequestTypeDef#

# GetEventActionRequestRequestTypeDef definition

class GetEventActionRequestRequestTypeDef(TypedDict):
    EventActionId: str,

GetJobRequestRequestTypeDef#

# GetJobRequestRequestTypeDef definition

class GetJobRequestRequestTypeDef(TypedDict):
    JobId: str,

GetRevisionRequestRequestTypeDef#

# GetRevisionRequestRequestTypeDef definition

class GetRevisionRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    RevisionId: str,

ImportAssetFromApiGatewayApiRequestDetailsTypeDef#

# ImportAssetFromApiGatewayApiRequestDetailsTypeDef definition

class ImportAssetFromApiGatewayApiRequestDetailsTypeDef(TypedDict):
    ApiId: str,
    ApiName: str,
    ApiSpecificationMd5Hash: str,
    DataSetId: str,
    ProtocolType: ProtocolTypeType,  # (1)
    RevisionId: str,
    Stage: str,
    ApiDescription: NotRequired[str],
    ApiKey: NotRequired[str],
  1. See ProtocolTypeType

ImportAssetFromApiGatewayApiResponseDetailsTypeDef#

# ImportAssetFromApiGatewayApiResponseDetailsTypeDef definition

class ImportAssetFromApiGatewayApiResponseDetailsTypeDef(TypedDict):
    ApiId: str,
    ApiName: str,
    ApiSpecificationMd5Hash: str,
    ApiSpecificationUploadUrl: str,
    ApiSpecificationUploadUrlExpiresAt: datetime,
    DataSetId: str,
    ProtocolType: ProtocolTypeType,  # (1)
    RevisionId: str,
    Stage: str,
    ApiDescription: NotRequired[str],
    ApiKey: NotRequired[str],
  1. See ProtocolTypeType

ImportAssetFromSignedUrlRequestDetailsTypeDef#

# ImportAssetFromSignedUrlRequestDetailsTypeDef definition

class ImportAssetFromSignedUrlRequestDetailsTypeDef(TypedDict):
    AssetName: str,
    DataSetId: str,
    Md5Hash: str,
    RevisionId: str,

ImportAssetFromSignedUrlResponseDetailsTypeDef#

# ImportAssetFromSignedUrlResponseDetailsTypeDef definition

class ImportAssetFromSignedUrlResponseDetailsTypeDef(TypedDict):
    AssetName: str,
    DataSetId: str,
    RevisionId: str,
    Md5Hash: NotRequired[str],
    SignedUrl: NotRequired[str],
    SignedUrlExpiresAt: NotRequired[datetime],

RedshiftDataShareAssetSourceEntryTypeDef#

# RedshiftDataShareAssetSourceEntryTypeDef definition

class RedshiftDataShareAssetSourceEntryTypeDef(TypedDict):
    DataShareArn: str,

KmsKeyToGrantTypeDef#

# KmsKeyToGrantTypeDef definition

class KmsKeyToGrantTypeDef(TypedDict):
    KmsKeyArn: str,

LakeFormationTagPolicyDetailsTypeDef#

# LakeFormationTagPolicyDetailsTypeDef definition

class LakeFormationTagPolicyDetailsTypeDef(TypedDict):
    Database: NotRequired[str],
    Table: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDataSetRevisionsRequestRequestTypeDef#

# ListDataSetRevisionsRequestRequestTypeDef definition

class ListDataSetRevisionsRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

RevisionEntryTypeDef#

# RevisionEntryTypeDef definition

class RevisionEntryTypeDef(TypedDict):
    Arn: str,
    CreatedAt: datetime,
    DataSetId: str,
    Id: str,
    UpdatedAt: datetime,
    Comment: NotRequired[str],
    Finalized: NotRequired[bool],
    SourceId: NotRequired[str],
    RevocationComment: NotRequired[str],
    Revoked: NotRequired[bool],
    RevokedAt: NotRequired[datetime],

ListDataSetsRequestRequestTypeDef#

# ListDataSetsRequestRequestTypeDef definition

class ListDataSetsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Origin: NotRequired[str],

ListEventActionsRequestRequestTypeDef#

# ListEventActionsRequestRequestTypeDef definition

class ListEventActionsRequestRequestTypeDef(TypedDict):
    EventSourceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListJobsRequestRequestTypeDef#

# ListJobsRequestRequestTypeDef definition

class ListJobsRequestRequestTypeDef(TypedDict):
    DataSetId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    RevisionId: NotRequired[str],

ListRevisionAssetsRequestRequestTypeDef#

# ListRevisionAssetsRequestRequestTypeDef definition

class ListRevisionAssetsRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    RevisionId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

RedshiftDataShareDetailsTypeDef#

# RedshiftDataShareDetailsTypeDef definition

class RedshiftDataShareDetailsTypeDef(TypedDict):
    Arn: str,
    Database: str,
    Function: NotRequired[str],
    Table: NotRequired[str],
    Schema: NotRequired[str],
    View: NotRequired[str],

RevokeRevisionRequestRequestTypeDef#

# RevokeRevisionRequestRequestTypeDef definition

class RevokeRevisionRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    RevisionId: str,
    RevocationComment: str,

S3DataAccessDetailsTypeDef#

# S3DataAccessDetailsTypeDef definition

class S3DataAccessDetailsTypeDef(TypedDict):
    KeyPrefixes: NotRequired[Sequence[str]],
    Keys: NotRequired[Sequence[str]],

SchemaChangeDetailsTypeDef#

# SchemaChangeDetailsTypeDef definition

class SchemaChangeDetailsTypeDef(TypedDict):
    Name: str,
    Type: SchemaChangeTypeType,  # (1)
    Description: NotRequired[str],
  1. See SchemaChangeTypeType

SendApiAssetRequestRequestTypeDef#

# SendApiAssetRequestRequestTypeDef definition

class SendApiAssetRequestRequestTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    RevisionId: str,
    Body: NotRequired[str],
    QueryStringParameters: NotRequired[Mapping[str, str]],
    RequestHeaders: NotRequired[Mapping[str, str]],
    Method: NotRequired[str],
    Path: NotRequired[str],

StartJobRequestRequestTypeDef#

# StartJobRequestRequestTypeDef definition

class StartJobRequestRequestTypeDef(TypedDict):
    JobId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateAssetRequestRequestTypeDef#

# UpdateAssetRequestRequestTypeDef definition

class UpdateAssetRequestRequestTypeDef(TypedDict):
    AssetId: str,
    DataSetId: str,
    Name: str,
    RevisionId: str,

UpdateDataSetRequestRequestTypeDef#

# UpdateDataSetRequestRequestTypeDef definition

class UpdateDataSetRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    Description: NotRequired[str],
    Name: NotRequired[str],

UpdateRevisionRequestRequestTypeDef#

# UpdateRevisionRequestRequestTypeDef definition

class UpdateRevisionRequestRequestTypeDef(TypedDict):
    DataSetId: str,
    RevisionId: str,
    Comment: NotRequired[str],
    Finalized: NotRequired[bool],

ImportAssetsFromS3RequestDetailsTypeDef#

# ImportAssetsFromS3RequestDetailsTypeDef definition

class ImportAssetsFromS3RequestDetailsTypeDef(TypedDict):
    AssetSources: Sequence[AssetSourceEntryTypeDef],  # (1)
    DataSetId: str,
    RevisionId: str,
  1. See AssetSourceEntryTypeDef

ImportAssetsFromS3ResponseDetailsTypeDef#

# ImportAssetsFromS3ResponseDetailsTypeDef definition

class ImportAssetsFromS3ResponseDetailsTypeDef(TypedDict):
    AssetSources: List[AssetSourceEntryTypeDef],  # (1)
    DataSetId: str,
    RevisionId: str,
  1. See AssetSourceEntryTypeDef

AutoExportRevisionToS3RequestDetailsTypeDef#

# AutoExportRevisionToS3RequestDetailsTypeDef definition

class AutoExportRevisionToS3RequestDetailsTypeDef(TypedDict):
    RevisionDestination: AutoExportRevisionDestinationEntryTypeDef,  # (2)
    Encryption: NotRequired[ExportServerSideEncryptionTypeDef],  # (1)
  1. See ExportServerSideEncryptionTypeDef
  2. See AutoExportRevisionDestinationEntryTypeDef

ExportAssetsToS3RequestDetailsTypeDef#

# ExportAssetsToS3RequestDetailsTypeDef definition

class ExportAssetsToS3RequestDetailsTypeDef(TypedDict):
    AssetDestinations: Sequence[AssetDestinationEntryTypeDef],  # (1)
    DataSetId: str,
    RevisionId: str,
    Encryption: NotRequired[ExportServerSideEncryptionTypeDef],  # (2)
  1. See AssetDestinationEntryTypeDef
  2. See ExportServerSideEncryptionTypeDef

ExportAssetsToS3ResponseDetailsTypeDef#

# ExportAssetsToS3ResponseDetailsTypeDef definition

class ExportAssetsToS3ResponseDetailsTypeDef(TypedDict):
    AssetDestinations: List[AssetDestinationEntryTypeDef],  # (1)
    DataSetId: str,
    RevisionId: str,
    Encryption: NotRequired[ExportServerSideEncryptionTypeDef],  # (2)
  1. See AssetDestinationEntryTypeDef
  2. See ExportServerSideEncryptionTypeDef

DataSetEntryTypeDef#

# DataSetEntryTypeDef definition

class DataSetEntryTypeDef(TypedDict):
    Arn: str,
    AssetType: AssetTypeType,  # (1)
    CreatedAt: datetime,
    Description: str,
    Id: str,
    Name: str,
    Origin: OriginType,  # (2)
    UpdatedAt: datetime,
    OriginDetails: NotRequired[OriginDetailsTypeDef],  # (3)
    SourceId: NotRequired[str],
  1. See AssetTypeType
  2. See OriginType
  3. See OriginDetailsTypeDef

CreateDataSetResponseTypeDef#

# CreateDataSetResponseTypeDef definition

class CreateDataSetResponseTypeDef(TypedDict):
    Arn: str,
    AssetType: AssetTypeType,  # (1)
    CreatedAt: datetime,
    Description: str,
    Id: str,
    Name: str,
    Origin: OriginType,  # (2)
    OriginDetails: OriginDetailsTypeDef,  # (3)
    SourceId: str,
    Tags: Dict[str, str],
    UpdatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AssetTypeType
  2. See