Skip to content

Supplychain Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BillOfMaterialsImportJob

instanceId

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['FAILED', 'IN_PROGRESS', 'NEW', 'QUEUED', 'SUCCESS']
  • Required: Yes

s3uri

  • Type:
  • Required: Yes

message

  • Type: typing.Optional[str]

CreateBillOfMaterialsImportJobRequest

instanceId

  • Type:
  • Required: Yes

s3uri

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

CreateBillOfMaterialsImportJobResponse

jobId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataIntegrationFlowRequest

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

sources

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowSource]
  • Required: Yes

transformation

  • Type:
  • Required: Yes

target

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateDataIntegrationFlowResponse

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDataLakeDatasetRequest

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

schema

  • Type: typing.Union[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataLakeDatasetSchema, aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataLakeDatasetSchemaOutput, NoneType]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateDataLakeDatasetResponse

dataset

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateInstanceRequest

instanceName

  • Type: typing.Optional[str]

instanceDescription

  • Type: typing.Optional[str]

kmsKeyArn

  • Type: typing.Optional[str]

webAppDnsDomain

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

CreateInstanceResponse

instance

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataIntegrationFlow

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

sources

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowSource]
  • Required: Yes

transformation

  • Type:
  • Required: Yes

target

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

DataIntegrationFlowDatasetOptions

loadType

  • Type: typing.Optional[typing.Literal['INCREMENTAL', 'REPLACE']]

dedupeRecords

  • Type: typing.Optional[bool]

DataIntegrationFlowDatasetSourceConfiguration

datasetIdentifier

  • Type:
  • Required: Yes

options

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowDatasetOptions]

DataIntegrationFlowDatasetTargetConfiguration

datasetIdentifier

  • Type:
  • Required: Yes

options

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowDatasetOptions]

DataIntegrationFlowS3Options

fileType

  • Type: typing.Optional[typing.Literal['CSV', 'JSON', 'PARQUET']]

DataIntegrationFlowS3SourceConfiguration

bucketName

  • Type:
  • Required: Yes

prefix

  • Type:
  • Required: Yes

options

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowS3Options]

DataIntegrationFlowS3TargetConfiguration

bucketName

  • Type:
  • Required: Yes

prefix

  • Type:
  • Required: Yes

options

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowS3Options]

DataIntegrationFlowSQLTransformationConfiguration

query

  • Type:
  • Required: Yes

DataIntegrationFlowSource

sourceType

  • Type: typing.Literal['DATASET', 'S3']
  • Required: Yes

sourceName

  • Type:
  • Required: Yes

s3Source

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowS3SourceConfiguration]

datasetSource

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowDatasetSourceConfiguration]

DataIntegrationFlowTarget

targetType

  • Type: typing.Literal['DATASET', 'S3']
  • Required: Yes

s3Target

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowS3TargetConfiguration]

datasetTarget

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowDatasetTargetConfiguration]

DataIntegrationFlowTransformation

transformationType

  • Type: typing.Literal['NONE', 'SQL']
  • Required: Yes

sqlTransformation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowSQLTransformationConfiguration]

DataLakeDataset

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

schema

  • Type:
  • Default: >

createdTime

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

DataLakeDatasetSchema

name

  • Type:
  • Required: Yes

fields

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataLakeDatasetSchemaField]
  • Required: Yes

DataLakeDatasetSchemaField

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DOUBLE', 'INT', 'STRING', 'TIMESTAMP']
  • Required: Yes

isRequired

  • Type:
  • Required: Yes

DataLakeDatasetSchemaOutput

name

  • Type:
  • Required: Yes

fields

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataLakeDatasetSchemaField]
  • Required: Yes

DeleteDataIntegrationFlowRequest

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

DeleteDataIntegrationFlowResponse

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDataLakeDatasetRequest

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

DeleteDataLakeDatasetResponse

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteInstanceRequest

instanceId

  • Type:
  • Required: Yes

DeleteInstanceResponse

instance

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetBillOfMaterialsImportJobRequest

instanceId

  • Type:
  • Required: Yes

jobId

  • Type:
  • Required: Yes

GetBillOfMaterialsImportJobResponse

job

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataIntegrationFlowRequest

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

GetDataIntegrationFlowResponse

flow

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataLakeDatasetRequest

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

GetDataLakeDatasetResponse

dataset

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInstanceRequest

instanceId

  • Type:
  • Required: Yes

GetInstanceResponse

instance

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Instance

instanceId

  • Type:
  • Required: Yes

awsAccountId

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['Active', 'CreateFailed', 'DeleteFailed', 'Deleted', 'Deleting', 'Initializing']
  • Required: Yes

errorMessage

  • Type: typing.Optional[str]

webAppDnsDomain

  • Type: typing.Optional[str]

createdTime

  • Type: typing.Optional[datetime.datetime]

lastModifiedTime

  • Type: typing.Optional[datetime.datetime]

instanceName

  • Type: typing.Optional[str]

instanceDescription

  • Type: typing.Optional[str]

kmsKeyArn

  • Type: typing.Optional[str]

versionNumber

  • Type: typing.Optional[float]

ListDataIntegrationFlowsRequest

instanceId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDataIntegrationFlowsRequestPaginate

instanceId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.PaginatorConfig]

ListDataIntegrationFlowsResponse

flows

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlow]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDataLakeDatasetsRequest

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDataLakeDatasetsRequestPaginate

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.PaginatorConfig]

ListDataLakeDatasetsResponse

datasets

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataLakeDataset]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListInstancesRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

instanceNameFilter

  • Type: typing.Optional[typing.List[str]]

instanceStateFilter

  • Type: typing.Optional[typing.List[typing.Literal['Active', 'CreateFailed', 'DeleteFailed', 'Deleted', 'Deleting', 'Initializing']]]

ListInstancesRequestPaginate

instanceNameFilter

  • Type: typing.Optional[typing.List[str]]

instanceStateFilter

  • Type: typing.Optional[typing.List[typing.Literal['Active', 'CreateFailed', 'DeleteFailed', 'Deleted', 'Deleting', 'Initializing']]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.PaginatorConfig]

ListInstancesResponse

instances

  • Type: typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.Instance]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SendDataIntegrationEventRequest

instanceId

  • Type:
  • Required: Yes

eventType

  • Type: typing.Literal['scn.data.forecast', 'scn.data.inboundorder', 'scn.data.inboundorderline', 'scn.data.inboundorderlineschedule', 'scn.data.inventorylevel', 'scn.data.outboundorderline', 'scn.data.outboundshipment', 'scn.data.processheader', 'scn.data.processoperation', 'scn.data.processproduct', 'scn.data.reservation', 'scn.data.shipment', 'scn.data.shipmentstop', 'scn.data.shipmentstoporder', 'scn.data.supplyplan']
  • Required: Yes

data

  • Type:
  • Required: Yes

eventGroupId

  • Type:
  • Required: Yes

eventTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

clientToken

  • Type: typing.Optional[str]

SendDataIntegrationEventResponse

eventId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateDataIntegrationFlowRequest

instanceId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

sources

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowSource]]

transformation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowTransformation]

target

  • Type: typing.Optional[aws_resource_validator.pydantic_models.supplychain.supplychain_classes.DataIntegrationFlowTarget]

UpdateDataIntegrationFlowResponse

flow

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDataLakeDatasetRequest

instanceId

  • Type:
  • Required: Yes

namespace

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateDataLakeDatasetResponse

dataset

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateInstanceRequest

instanceId

  • Type:
  • Required: Yes

instanceName

  • Type: typing.Optional[str]

instanceDescription

  • Type: typing.Optional[str]

UpdateInstanceResponse

instance

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes