Skip to content

Type definitions#

Index > SupplyChain > Type definitions

Auto-generated documentation for SupplyChain type annotations stubs module mypy-boto3-supplychain.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BillOfMaterialsImportJobTypeDef#

# BillOfMaterialsImportJobTypeDef definition

class BillOfMaterialsImportJobTypeDef(TypedDict):
    instanceId: str,
    jobId: str,
    status: ConfigurationJobStatusType,  # (1)
    s3uri: str,
    message: NotRequired[str],
  1. See ConfigurationJobStatusType

CreateBillOfMaterialsImportJobRequestRequestTypeDef#

# CreateBillOfMaterialsImportJobRequestRequestTypeDef definition

class CreateBillOfMaterialsImportJobRequestRequestTypeDef(TypedDict):
    instanceId: str,
    s3uri: str,
    clientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateInstanceRequestRequestTypeDef#

# CreateInstanceRequestRequestTypeDef definition

class CreateInstanceRequestRequestTypeDef(TypedDict):
    instanceName: NotRequired[str],
    instanceDescription: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    instanceId: str,
    awsAccountId: str,
    state: InstanceStateType,  # (1)
    errorMessage: NotRequired[str],
    webAppDnsDomain: NotRequired[str],
    createdTime: NotRequired[datetime],
    lastModifiedTime: NotRequired[datetime],
    instanceName: NotRequired[str],
    instanceDescription: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    versionNumber: NotRequired[float],
  1. See InstanceStateType

DataIntegrationFlowDatasetOptionsTypeDef#

# DataIntegrationFlowDatasetOptionsTypeDef definition

class DataIntegrationFlowDatasetOptionsTypeDef(TypedDict):
    loadType: NotRequired[DataIntegrationFlowLoadTypeType],  # (1)
    dedupeRecords: NotRequired[bool],
  1. See DataIntegrationFlowLoadTypeType

DataIntegrationFlowS3OptionsTypeDef#

# DataIntegrationFlowS3OptionsTypeDef definition

class DataIntegrationFlowS3OptionsTypeDef(TypedDict):
    fileType: NotRequired[DataIntegrationFlowFileTypeType],  # (1)
  1. See DataIntegrationFlowFileTypeType

DataIntegrationFlowSQLTransformationConfigurationTypeDef#

# DataIntegrationFlowSQLTransformationConfigurationTypeDef definition

class DataIntegrationFlowSQLTransformationConfigurationTypeDef(TypedDict):
    query: str,

DataLakeDatasetSchemaFieldTypeDef#

# DataLakeDatasetSchemaFieldTypeDef definition

class DataLakeDatasetSchemaFieldTypeDef(TypedDict):
    name: str,
    type: DataLakeDatasetSchemaFieldTypeType,  # (1)
    isRequired: bool,
  1. See DataLakeDatasetSchemaFieldTypeType

DeleteDataIntegrationFlowRequestRequestTypeDef#

# DeleteDataIntegrationFlowRequestRequestTypeDef definition

class DeleteDataIntegrationFlowRequestRequestTypeDef(TypedDict):
    instanceId: str,
    name: str,

DeleteDataLakeDatasetRequestRequestTypeDef#

# DeleteDataLakeDatasetRequestRequestTypeDef definition

class DeleteDataLakeDatasetRequestRequestTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,

DeleteInstanceRequestRequestTypeDef#

# DeleteInstanceRequestRequestTypeDef definition

class DeleteInstanceRequestRequestTypeDef(TypedDict):
    instanceId: str,

GetBillOfMaterialsImportJobRequestRequestTypeDef#

# GetBillOfMaterialsImportJobRequestRequestTypeDef definition

class GetBillOfMaterialsImportJobRequestRequestTypeDef(TypedDict):
    instanceId: str,
    jobId: str,

GetDataIntegrationFlowRequestRequestTypeDef#

# GetDataIntegrationFlowRequestRequestTypeDef definition

class GetDataIntegrationFlowRequestRequestTypeDef(TypedDict):
    instanceId: str,
    name: str,

GetDataLakeDatasetRequestRequestTypeDef#

# GetDataLakeDatasetRequestRequestTypeDef definition

class GetDataLakeDatasetRequestRequestTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,

GetInstanceRequestRequestTypeDef#

# GetInstanceRequestRequestTypeDef definition

class GetInstanceRequestRequestTypeDef(TypedDict):
    instanceId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListDataIntegrationFlowsRequestRequestTypeDef#

# ListDataIntegrationFlowsRequestRequestTypeDef definition

class ListDataIntegrationFlowsRequestRequestTypeDef(TypedDict):
    instanceId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDataLakeDatasetsRequestRequestTypeDef#

# ListDataLakeDatasetsRequestRequestTypeDef definition

class ListDataLakeDatasetsRequestRequestTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListInstancesRequestRequestTypeDef#

# ListInstancesRequestRequestTypeDef definition

class ListInstancesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    instanceNameFilter: NotRequired[Sequence[str]],
    instanceStateFilter: NotRequired[Sequence[InstanceStateType]],  # (1)
  1. See InstanceStateType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateDataLakeDatasetRequestRequestTypeDef#

# UpdateDataLakeDatasetRequestRequestTypeDef definition

class UpdateDataLakeDatasetRequestRequestTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,
    description: NotRequired[str],

UpdateInstanceRequestRequestTypeDef#

# UpdateInstanceRequestRequestTypeDef definition

class UpdateInstanceRequestRequestTypeDef(TypedDict):
    instanceId: str,
    instanceName: NotRequired[str],
    instanceDescription: NotRequired[str],

CreateBillOfMaterialsImportJobResponseTypeDef#

# CreateBillOfMaterialsImportJobResponseTypeDef definition

class CreateBillOfMaterialsImportJobResponseTypeDef(TypedDict):
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataIntegrationFlowResponseTypeDef#

# CreateDataIntegrationFlowResponseTypeDef definition

class CreateDataIntegrationFlowResponseTypeDef(TypedDict):
    instanceId: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDataIntegrationFlowResponseTypeDef#

# DeleteDataIntegrationFlowResponseTypeDef definition

class DeleteDataIntegrationFlowResponseTypeDef(TypedDict):
    instanceId: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDataLakeDatasetResponseTypeDef#

# DeleteDataLakeDatasetResponseTypeDef definition

class DeleteDataLakeDatasetResponseTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBillOfMaterialsImportJobResponseTypeDef#

# GetBillOfMaterialsImportJobResponseTypeDef definition

class GetBillOfMaterialsImportJobResponseTypeDef(TypedDict):
    job: BillOfMaterialsImportJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BillOfMaterialsImportJobTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendDataIntegrationEventResponseTypeDef#

# SendDataIntegrationEventResponseTypeDef definition

class SendDataIntegrationEventResponseTypeDef(TypedDict):
    eventId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateInstanceResponseTypeDef#

# CreateInstanceResponseTypeDef definition

class CreateInstanceResponseTypeDef(TypedDict):
    instance: InstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

DeleteInstanceResponseTypeDef#

# DeleteInstanceResponseTypeDef definition

class DeleteInstanceResponseTypeDef(TypedDict):
    instance: InstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

GetInstanceResponseTypeDef#

# GetInstanceResponseTypeDef definition

class GetInstanceResponseTypeDef(TypedDict):
    instance: InstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

ListInstancesResponseTypeDef#

# ListInstancesResponseTypeDef definition

class ListInstancesResponseTypeDef(TypedDict):
    instances: list[InstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

UpdateInstanceResponseTypeDef#

# UpdateInstanceResponseTypeDef definition

class UpdateInstanceResponseTypeDef(TypedDict):
    instance: InstanceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

DataIntegrationFlowDatasetSourceConfigurationTypeDef#

# DataIntegrationFlowDatasetSourceConfigurationTypeDef definition

class DataIntegrationFlowDatasetSourceConfigurationTypeDef(TypedDict):
    datasetIdentifier: str,
    options: NotRequired[DataIntegrationFlowDatasetOptionsTypeDef],  # (1)
  1. See DataIntegrationFlowDatasetOptionsTypeDef

DataIntegrationFlowDatasetTargetConfigurationTypeDef#

# DataIntegrationFlowDatasetTargetConfigurationTypeDef definition

class DataIntegrationFlowDatasetTargetConfigurationTypeDef(TypedDict):
    datasetIdentifier: str,
    options: NotRequired[DataIntegrationFlowDatasetOptionsTypeDef],  # (1)
  1. See DataIntegrationFlowDatasetOptionsTypeDef

DataIntegrationFlowS3SourceConfigurationTypeDef#

# DataIntegrationFlowS3SourceConfigurationTypeDef definition

class DataIntegrationFlowS3SourceConfigurationTypeDef(TypedDict):
    bucketName: str,
    prefix: str,
    options: NotRequired[DataIntegrationFlowS3OptionsTypeDef],  # (1)
  1. See DataIntegrationFlowS3OptionsTypeDef

DataIntegrationFlowS3TargetConfigurationTypeDef#

# DataIntegrationFlowS3TargetConfigurationTypeDef definition

class DataIntegrationFlowS3TargetConfigurationTypeDef(TypedDict):
    bucketName: str,
    prefix: str,
    options: NotRequired[DataIntegrationFlowS3OptionsTypeDef],  # (1)
  1. See DataIntegrationFlowS3OptionsTypeDef

DataIntegrationFlowTransformationTypeDef#

# DataIntegrationFlowTransformationTypeDef definition

class DataIntegrationFlowTransformationTypeDef(TypedDict):
    transformationType: DataIntegrationFlowTransformationTypeType,  # (1)
    sqlTransformation: NotRequired[DataIntegrationFlowSQLTransformationConfigurationTypeDef],  # (2)
  1. See DataIntegrationFlowTransformationTypeType
  2. See DataIntegrationFlowSQLTransformationConfigurationTypeDef

DataLakeDatasetSchemaOutputTypeDef#

# DataLakeDatasetSchemaOutputTypeDef definition

class DataLakeDatasetSchemaOutputTypeDef(TypedDict):
    name: str,
    fields: list[DataLakeDatasetSchemaFieldTypeDef],  # (1)
  1. See DataLakeDatasetSchemaFieldTypeDef

DataLakeDatasetSchemaTypeDef#

# DataLakeDatasetSchemaTypeDef definition

class DataLakeDatasetSchemaTypeDef(TypedDict):
    name: str,
    fields: Sequence[DataLakeDatasetSchemaFieldTypeDef],  # (1)
  1. See DataLakeDatasetSchemaFieldTypeDef

ListDataIntegrationFlowsRequestPaginateTypeDef#

# ListDataIntegrationFlowsRequestPaginateTypeDef definition

class ListDataIntegrationFlowsRequestPaginateTypeDef(TypedDict):
    instanceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDataLakeDatasetsRequestPaginateTypeDef#

# ListDataLakeDatasetsRequestPaginateTypeDef definition

class ListDataLakeDatasetsRequestPaginateTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListInstancesRequestPaginateTypeDef#

# ListInstancesRequestPaginateTypeDef definition

class ListInstancesRequestPaginateTypeDef(TypedDict):
    instanceNameFilter: NotRequired[Sequence[str]],
    instanceStateFilter: NotRequired[Sequence[InstanceStateType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See InstanceStateType
  2. See PaginatorConfigTypeDef

SendDataIntegrationEventRequestRequestTypeDef#

# SendDataIntegrationEventRequestRequestTypeDef definition

class SendDataIntegrationEventRequestRequestTypeDef(TypedDict):
    instanceId: str,
    eventType: DataIntegrationEventTypeType,  # (1)
    data: str,
    eventGroupId: str,
    eventTimestamp: NotRequired[TimestampTypeDef],
    clientToken: NotRequired[str],
  1. See DataIntegrationEventTypeType

DataIntegrationFlowSourceTypeDef#

# DataIntegrationFlowSourceTypeDef definition

class DataIntegrationFlowSourceTypeDef(TypedDict):
    sourceType: DataIntegrationFlowSourceTypeType,  # (1)
    sourceName: str,
    s3Source: NotRequired[DataIntegrationFlowS3SourceConfigurationTypeDef],  # (2)
    datasetSource: NotRequired[DataIntegrationFlowDatasetSourceConfigurationTypeDef],  # (3)
  1. See DataIntegrationFlowSourceTypeType
  2. See DataIntegrationFlowS3SourceConfigurationTypeDef
  3. See DataIntegrationFlowDatasetSourceConfigurationTypeDef

DataIntegrationFlowTargetTypeDef#

# DataIntegrationFlowTargetTypeDef definition

class DataIntegrationFlowTargetTypeDef(TypedDict):
    targetType: DataIntegrationFlowTargetTypeType,  # (1)
    s3Target: NotRequired[DataIntegrationFlowS3TargetConfigurationTypeDef],  # (2)
    datasetTarget: NotRequired[DataIntegrationFlowDatasetTargetConfigurationTypeDef],  # (3)
  1. See DataIntegrationFlowTargetTypeType
  2. See DataIntegrationFlowS3TargetConfigurationTypeDef
  3. See DataIntegrationFlowDatasetTargetConfigurationTypeDef

DataLakeDatasetTypeDef#

# DataLakeDatasetTypeDef definition

class DataLakeDatasetTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,
    arn: str,
    schema: DataLakeDatasetSchemaOutputTypeDef,  # (1)
    createdTime: datetime,
    lastModifiedTime: datetime,
    description: NotRequired[str],
  1. See DataLakeDatasetSchemaOutputTypeDef

CreateDataLakeDatasetRequestRequestTypeDef#

# CreateDataLakeDatasetRequestRequestTypeDef definition

class CreateDataLakeDatasetRequestRequestTypeDef(TypedDict):
    instanceId: str,
    namespace: str,
    name: str,
    schema: NotRequired[DataLakeDatasetSchemaTypeDef],  # (1)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See DataLakeDatasetSchemaTypeDef

CreateDataIntegrationFlowRequestRequestTypeDef#

# CreateDataIntegrationFlowRequestRequestTypeDef definition

class CreateDataIntegrationFlowRequestRequestTypeDef(TypedDict):
    instanceId: str,
    name: str,
    sources: Sequence[DataIntegrationFlowSourceTypeDef],  # (1)
    transformation: DataIntegrationFlowTransformationTypeDef,  # (2)
    target: DataIntegrationFlowTargetTypeDef,  # (3)
    tags: NotRequired[Mapping[str, str]],
  1. See DataIntegrationFlowSourceTypeDef
  2. See DataIntegrationFlowTransformationTypeDef
  3. See DataIntegrationFlowTargetTypeDef

DataIntegrationFlowTypeDef#

# DataIntegrationFlowTypeDef definition

class DataIntegrationFlowTypeDef(TypedDict):
    instanceId: str,
    name: str,
    sources: list[DataIntegrationFlowSourceTypeDef],  # (1)
    transformation: DataIntegrationFlowTransformationTypeDef,  # (2)
    target: DataIntegrationFlowTargetTypeDef,  # (3)
    createdTime: datetime,
    lastModifiedTime: datetime,
  1. See DataIntegrationFlowSourceTypeDef
  2. See DataIntegrationFlowTransformationTypeDef
  3. See DataIntegrationFlowTargetTypeDef

UpdateDataIntegrationFlowRequestRequestTypeDef#

# UpdateDataIntegrationFlowRequestRequestTypeDef definition

class UpdateDataIntegrationFlowRequestRequestTypeDef(TypedDict):
    instanceId: str,
    name: str,
    sources: NotRequired[Sequence[DataIntegrationFlowSourceTypeDef]],  # (1)
    transformation: NotRequired[DataIntegrationFlowTransformationTypeDef],  # (2)
    target: NotRequired[DataIntegrationFlowTargetTypeDef],  # (3)
  1. See DataIntegrationFlowSourceTypeDef
  2. See DataIntegrationFlowTransformationTypeDef
  3. See DataIntegrationFlowTargetTypeDef

CreateDataLakeDatasetResponseTypeDef#

# CreateDataLakeDatasetResponseTypeDef definition

class CreateDataLakeDatasetResponseTypeDef(TypedDict):
    dataset: DataLakeDatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeDatasetTypeDef
  2. See ResponseMetadataTypeDef

GetDataLakeDatasetResponseTypeDef#

# GetDataLakeDatasetResponseTypeDef definition

class GetDataLakeDatasetResponseTypeDef(TypedDict):
    dataset: DataLakeDatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeDatasetTypeDef
  2. See ResponseMetadataTypeDef

ListDataLakeDatasetsResponseTypeDef#

# ListDataLakeDatasetsResponseTypeDef definition

class ListDataLakeDatasetsResponseTypeDef(TypedDict):
    datasets: list[DataLakeDatasetTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DataLakeDatasetTypeDef
  2. See ResponseMetadataTypeDef

UpdateDataLakeDatasetResponseTypeDef#

# UpdateDataLakeDatasetResponseTypeDef definition

class UpdateDataLakeDatasetResponseTypeDef(TypedDict):
    dataset: DataLakeDatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataLakeDatasetTypeDef
  2. See ResponseMetadataTypeDef

GetDataIntegrationFlowResponseTypeDef#

# GetDataIntegrationFlowResponseTypeDef definition

class GetDataIntegrationFlowResponseTypeDef(TypedDict):
    flow: DataIntegrationFlowTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataIntegrationFlowTypeDef
  2. See ResponseMetadataTypeDef

ListDataIntegrationFlowsResponseTypeDef#

# ListDataIntegrationFlowsResponseTypeDef definition

class ListDataIntegrationFlowsResponseTypeDef(TypedDict):
    flows: list[DataIntegrationFlowTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DataIntegrationFlowTypeDef
  2. See ResponseMetadataTypeDef

UpdateDataIntegrationFlowResponseTypeDef#

# UpdateDataIntegrationFlowResponseTypeDef definition

class UpdateDataIntegrationFlowResponseTypeDef(TypedDict):
    flow: DataIntegrationFlowTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataIntegrationFlowTypeDef
  2. See ResponseMetadataTypeDef