AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.
The AWS Supply Chain API supports configuration data import for Supply Planning.
All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.
", "operations": { "CreateBillOfMaterialsImportJob": "CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.
The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.
", "CreateDataIntegrationFlow": "Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
", "CreateDataLakeDataset": "Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.
", "CreateInstance": "Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
", "DeleteDataIntegrationFlow": "Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", "DeleteDataLakeDataset": "Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.
", "DeleteInstance": "Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.
", "GetBillOfMaterialsImportJob": "Get status and details of a BillOfMaterialsImportJob.
", "GetDataIntegrationFlow": "Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", "GetDataLakeDataset": "Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.
", "GetInstance": "Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
", "ListDataIntegrationFlows": "Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
", "ListDataLakeDatasets": "Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.
", "ListInstances": "List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).
", "ListTagsForResource": "List all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.
", "SendDataIntegrationEvent": "Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
", "TagResource": "You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.
", "UntagResource": "You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.
", "UpdateDataIntegrationFlow": "Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
", "UpdateDataLakeDataset": "Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.
", "UpdateInstance": "Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have the required privileges to perform this action.
", "refs": { } }, "AscResourceArn": { "base": null, "refs": { "DataLakeDataset$arn": "The arn of the dataset.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs tags to be listed.
", "TagResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs to be tagged.
", "UntagResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs to be untagged.
" } }, "AwsAccountId": { "base": null, "refs": { "Instance$awsAccountId": "The Amazon Web Services account ID that owns the instance.
" } }, "BillOfMaterialsImportJob": { "base": "The BillOfMaterialsImportJob details.
", "refs": { "GetBillOfMaterialsImportJobResponse$job": "The BillOfMaterialsImportJob.
" } }, "Boolean": { "base": null, "refs": { "DataIntegrationFlowDatasetOptions$dedupeRecords": "The dataset load option to remove duplicates.
", "DataLakeDatasetSchemaField$isRequired": "Indicate if the field is required or not.
" } }, "ClientToken": { "base": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "refs": { "CreateBillOfMaterialsImportJobRequest$clientToken": "An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request.
", "CreateInstanceRequest$clientToken": "The client token for idempotency.
", "SendDataIntegrationEventRequest$clientToken": "The idempotent client token.
" } }, "ConfigurationJobStatus": { "base": "The status of the job.
", "refs": { "BillOfMaterialsImportJob$status": "The BillOfMaterialsImportJob ConfigurationJobStatus.
" } }, "ConfigurationS3Uri": { "base": null, "refs": { "BillOfMaterialsImportJob$s3uri": "The S3 URI from which the CSV is read.
", "CreateBillOfMaterialsImportJobRequest$s3uri": "The S3 URI of the CSV file to be imported. The bucket must grant permissions for AWS Supply Chain to read the file.
" } }, "ConflictException": { "base": "Updating or deleting a resource can cause an inconsistent state.
", "refs": { } }, "CreateBillOfMaterialsImportJobRequest": { "base": "The request parameters for CreateBillOfMaterialsImportJob.
", "refs": { } }, "CreateBillOfMaterialsImportJobResponse": { "base": "The response parameters of CreateBillOfMaterialsImportJob.
", "refs": { } }, "CreateDataIntegrationFlowRequest": { "base": "The request parameters for CreateDataIntegrationFlow.
", "refs": { } }, "CreateDataIntegrationFlowResponse": { "base": "The response parameters for CreateDataIntegrationFlow.
", "refs": { } }, "CreateDataLakeDatasetRequest": { "base": "The request parameters for CreateDataLakeDataset.
", "refs": { } }, "CreateDataLakeDatasetResponse": { "base": "The response parameters of CreateDataLakeDataset.
", "refs": { } }, "CreateInstanceRequest": { "base": "The request parameters for CreateInstance.
", "refs": { } }, "CreateInstanceResponse": { "base": "The response parameters for CreateInstance.
", "refs": { } }, "DataIntegrationEventData": { "base": null, "refs": { "SendDataIntegrationEventRequest$data": "The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain .
" } }, "DataIntegrationEventGroupId": { "base": null, "refs": { "SendDataIntegrationEventRequest$eventGroupId": "Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
" } }, "DataIntegrationEventType": { "base": null, "refs": { "SendDataIntegrationEventRequest$eventType": "The data event type.
" } }, "DataIntegrationFlow": { "base": "The DataIntegrationFlow details.
", "refs": { "DataIntegrationFlowList$member": null, "GetDataIntegrationFlowResponse$flow": "The details of the DataIntegrationFlow returned.
", "UpdateDataIntegrationFlowResponse$flow": "The details of the updated DataIntegrationFlow.
" } }, "DataIntegrationFlowDatasetOptions": { "base": "The dataset options used in dataset source and target configurations.
", "refs": { "DataIntegrationFlowDatasetSourceConfiguration$options": "The dataset DataIntegrationFlow source options.
", "DataIntegrationFlowDatasetTargetConfiguration$options": "The dataset DataIntegrationFlow target options.
" } }, "DataIntegrationFlowDatasetSourceConfiguration": { "base": "The dataset DataIntegrationFlow source configuration parameters.
", "refs": { "DataIntegrationFlowSource$datasetSource": "The dataset DataIntegrationFlow source.
" } }, "DataIntegrationFlowDatasetTargetConfiguration": { "base": "The dataset DataIntegrationFlow target configuration parameters.
", "refs": { "DataIntegrationFlowTarget$datasetTarget": "The dataset DataIntegrationFlow target.
" } }, "DataIntegrationFlowFileType": { "base": null, "refs": { "DataIntegrationFlowS3Options$fileType": "The Amazon S3 file type in S3 options.
" } }, "DataIntegrationFlowList": { "base": null, "refs": { "ListDataIntegrationFlowsResponse$flows": "The response parameters for ListDataIntegrationFlows.
" } }, "DataIntegrationFlowLoadType": { "base": null, "refs": { "DataIntegrationFlowDatasetOptions$loadType": "The dataset data load type in dataset options.
" } }, "DataIntegrationFlowMaxResults": { "base": null, "refs": { "ListDataIntegrationFlowsRequest$maxResults": "Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.
" } }, "DataIntegrationFlowName": { "base": null, "refs": { "CreateDataIntegrationFlowRequest$name": "Name of the DataIntegrationFlow.
", "CreateDataIntegrationFlowResponse$name": "The name of the DataIntegrationFlow created.
", "DataIntegrationFlow$name": "The DataIntegrationFlow name.
", "DeleteDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow to be deleted.
", "DeleteDataIntegrationFlowResponse$name": "The name of the DataIntegrationFlow deleted.
", "GetDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow created.
", "UpdateDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow to be updated.
" } }, "DataIntegrationFlowNextToken": { "base": null, "refs": { "ListDataIntegrationFlowsRequest$nextToken": "The pagination token to fetch the next page of the DataIntegrationFlows.
", "ListDataIntegrationFlowsResponse$nextToken": "The pagination token to fetch the next page of the DataIntegrationFlows.
" } }, "DataIntegrationFlowS3Options": { "base": "The Amazon S3 options used in S3 source and target configurations.
", "refs": { "DataIntegrationFlowS3SourceConfiguration$options": "The other options of the S3 DataIntegrationFlow source.
", "DataIntegrationFlowS3TargetConfiguration$options": "The S3 DataIntegrationFlow target options.
" } }, "DataIntegrationFlowS3Prefix": { "base": null, "refs": { "DataIntegrationFlowS3SourceConfiguration$prefix": "The prefix of the S3 source objects.
", "DataIntegrationFlowS3TargetConfiguration$prefix": "The prefix of the S3 target objects.
" } }, "DataIntegrationFlowS3SourceConfiguration": { "base": "The S3 DataIntegrationFlow source configuration parameters.
", "refs": { "DataIntegrationFlowSource$s3Source": "The S3 DataIntegrationFlow source.
" } }, "DataIntegrationFlowS3TargetConfiguration": { "base": "The S3 DataIntegrationFlow target configuration parameters.
", "refs": { "DataIntegrationFlowTarget$s3Target": "The S3 DataIntegrationFlow target.
" } }, "DataIntegrationFlowSQLQuery": { "base": null, "refs": { "DataIntegrationFlowSQLTransformationConfiguration$query": "The transformation SQL query body based on SparkSQL.
" } }, "DataIntegrationFlowSQLTransformationConfiguration": { "base": "The SQL DataIntegrationFlow transformation configuration parameters.
", "refs": { "DataIntegrationFlowTransformation$sqlTransformation": "The SQL DataIntegrationFlow transformation configuration.
" } }, "DataIntegrationFlowSource": { "base": "The DataIntegrationFlow source parameters.
", "refs": { "DataIntegrationFlowSourceList$member": null } }, "DataIntegrationFlowSourceList": { "base": null, "refs": { "CreateDataIntegrationFlowRequest$sources": "The source configurations for DataIntegrationFlow.
", "DataIntegrationFlow$sources": "The DataIntegrationFlow source configurations.
", "UpdateDataIntegrationFlowRequest$sources": "The new source configurations for the DataIntegrationFlow.
" } }, "DataIntegrationFlowSourceName": { "base": null, "refs": { "DataIntegrationFlowSource$sourceName": "The DataIntegrationFlow source name that can be used as table alias in SQL transformation query.
" } }, "DataIntegrationFlowSourceType": { "base": null, "refs": { "DataIntegrationFlowSource$sourceType": "The DataIntegrationFlow source type.
" } }, "DataIntegrationFlowTarget": { "base": "The DataIntegrationFlow target parameters.
", "refs": { "CreateDataIntegrationFlowRequest$target": "The target configurations for DataIntegrationFlow.
", "DataIntegrationFlow$target": "The DataIntegrationFlow target configuration.
", "UpdateDataIntegrationFlowRequest$target": "The new target configurations for the DataIntegrationFlow.
" } }, "DataIntegrationFlowTargetType": { "base": null, "refs": { "DataIntegrationFlowTarget$targetType": "The DataIntegrationFlow target type.
" } }, "DataIntegrationFlowTransformation": { "base": "The DataIntegrationFlow transformation parameters.
", "refs": { "CreateDataIntegrationFlowRequest$transformation": "The transformation configurations for DataIntegrationFlow.
", "DataIntegrationFlow$transformation": "The DataIntegrationFlow transformation configurations.
", "UpdateDataIntegrationFlowRequest$transformation": "The new transformation configurations for the DataIntegrationFlow.
" } }, "DataIntegrationFlowTransformationType": { "base": null, "refs": { "DataIntegrationFlowTransformation$transformationType": "The DataIntegrationFlow transformation type.
" } }, "DataLakeDataset": { "base": "The data lake dataset details.
", "refs": { "CreateDataLakeDatasetResponse$dataset": "The detail of created dataset.
", "DataLakeDatasetList$member": null, "GetDataLakeDatasetResponse$dataset": "The fetched dataset details.
", "UpdateDataLakeDatasetResponse$dataset": "The updated dataset details.
" } }, "DataLakeDatasetDescription": { "base": null, "refs": { "CreateDataLakeDatasetRequest$description": "The description of the dataset.
", "DataLakeDataset$description": "The description of the dataset.
", "UpdateDataLakeDatasetRequest$description": "The updated description of the data lake dataset.
" } }, "DataLakeDatasetList": { "base": null, "refs": { "ListDataLakeDatasetsResponse$datasets": "The list of fetched dataset details.
" } }, "DataLakeDatasetMaxResults": { "base": null, "refs": { "ListDataLakeDatasetsRequest$maxResults": "The max number of datasets to fetch in this paginated request.
" } }, "DataLakeDatasetName": { "base": null, "refs": { "CreateDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "DataLakeDataset$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "DeleteDataLakeDatasetRequest$name": "The name of the dataset. If the namespace is asc, the name must be one of the supported data entities .
", "DeleteDataLakeDatasetResponse$name": "The name of deleted dataset.
", "GetDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "UpdateDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" } }, "DataLakeDatasetNamespace": { "base": null, "refs": { "CreateDataLakeDatasetRequest$namespace": "The name space of the dataset.
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The namespace of deleted dataset.
", "GetDataLakeDatasetRequest$namespace": "The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The pagination token to fetch next page of datasets.
", "ListDataLakeDatasetsResponse$nextToken": "The pagination token to fetch next page of datasets.
" } }, "DataLakeDatasetSchema": { "base": "The schema details of the dataset.
", "refs": { "CreateDataLakeDatasetRequest$schema": "The custom schema of the data lake dataset and is only required when the name space is default.
", "DataLakeDataset$schema": "The schema of the dataset.
" } }, "DataLakeDatasetSchemaField": { "base": "The dataset field details.
", "refs": { "DataLakeDatasetSchemaFieldList$member": null } }, "DataLakeDatasetSchemaFieldList": { "base": null, "refs": { "DataLakeDatasetSchema$fields": "The list of field details of the dataset schema.
" } }, "DataLakeDatasetSchemaFieldName": { "base": null, "refs": { "DataLakeDatasetSchemaField$name": "The dataset field name.
" } }, "DataLakeDatasetSchemaFieldType": { "base": null, "refs": { "DataLakeDatasetSchemaField$type": "The dataset field type.
" } }, "DataLakeDatasetSchemaName": { "base": null, "refs": { "DataLakeDatasetSchema$name": "The name of the dataset schema.
" } }, "DatasetIdentifier": { "base": null, "refs": { "DataIntegrationFlowDatasetSourceConfiguration$datasetIdentifier": "The ARN of the dataset.
", "DataIntegrationFlowDatasetTargetConfiguration$datasetIdentifier": "The dataset ARN.
" } }, "DeleteDataIntegrationFlowRequest": { "base": "The request parameters for DeleteDataIntegrationFlow.
", "refs": { } }, "DeleteDataIntegrationFlowResponse": { "base": "The response parameters for DeleteDataIntegrationFlow.
", "refs": { } }, "DeleteDataLakeDatasetRequest": { "base": "The request parameters of DeleteDataLakeDataset.
", "refs": { } }, "DeleteDataLakeDatasetResponse": { "base": "The response parameters of DeleteDataLakeDataset.
", "refs": { } }, "DeleteInstanceRequest": { "base": "The request parameters for DeleteInstance.
", "refs": { } }, "DeleteInstanceResponse": { "base": "The response parameters for DeleteInstance.
", "refs": { } }, "Double": { "base": null, "refs": { "Instance$versionNumber": "The version number of the instance.
" } }, "GetBillOfMaterialsImportJobRequest": { "base": "The request parameters for GetBillOfMaterialsImportJob.
", "refs": { } }, "GetBillOfMaterialsImportJobResponse": { "base": "The response parameters for GetBillOfMaterialsImportJob.
", "refs": { } }, "GetDataIntegrationFlowRequest": { "base": "The request parameters for GetDataIntegrationFlow.
", "refs": { } }, "GetDataIntegrationFlowResponse": { "base": "The response parameters for GetDataIntegrationFlow.
", "refs": { } }, "GetDataLakeDatasetRequest": { "base": "The request parameters for GetDataLakeDataset.
", "refs": { } }, "GetDataLakeDatasetResponse": { "base": "The response parameters for UpdateDataLakeDataset.
", "refs": { } }, "GetInstanceRequest": { "base": "The request parameters for GetInstance.
", "refs": { } }, "GetInstanceResponse": { "base": "The response parameters for GetInstance.
", "refs": { } }, "Instance": { "base": "The details of the instance.
", "refs": { "CreateInstanceResponse$instance": "The AWS Supply Chain instance resource data details.
", "DeleteInstanceResponse$instance": "The AWS Supply Chain instance resource data details.
", "GetInstanceResponse$instance": "The instance resource data details.
", "InstanceList$member": null, "UpdateInstanceResponse$instance": "The instance resource data details.
" } }, "InstanceDescription": { "base": null, "refs": { "CreateInstanceRequest$instanceDescription": "The AWS Supply Chain instance description.
", "Instance$instanceDescription": "The Amazon Web Services Supply Chain instance description.
", "UpdateInstanceRequest$instanceDescription": "The AWS Supply Chain instance description.
" } }, "InstanceList": { "base": null, "refs": { "ListInstancesResponse$instances": "The list of instances resource data details.
" } }, "InstanceMaxResults": { "base": null, "refs": { "ListInstancesRequest$maxResults": "Specify the maximum number of instances to fetch in this paginated request.
" } }, "InstanceName": { "base": null, "refs": { "CreateInstanceRequest$instanceName": "The AWS Supply Chain instance name.
", "Instance$instanceName": "The Amazon Web Services Supply Chain instance name.
", "InstanceNameList$member": null, "UpdateInstanceRequest$instanceName": "The AWS Supply Chain instance name.
" } }, "InstanceNameList": { "base": null, "refs": { "ListInstancesRequest$instanceNameFilter": "The filter to ListInstances based on their names.
" } }, "InstanceNextToken": { "base": null, "refs": { "ListInstancesRequest$nextToken": "The pagination token to fetch the next page of instances.
", "ListInstancesResponse$nextToken": "The pagination token to fetch the next page of instances.
" } }, "InstanceState": { "base": null, "refs": { "Instance$state": "The state of the instance.
", "InstanceStateList$member": null } }, "InstanceStateList": { "base": null, "refs": { "ListInstancesRequest$instanceStateFilter": "The filter to ListInstances based on their state.
" } }, "InstanceWebAppDnsDomain": { "base": null, "refs": { "Instance$webAppDnsDomain": "The WebApp DNS domain name of the instance.
" } }, "InternalServerException": { "base": "Unexpected error during processing of request.
", "refs": { } }, "KmsKeyArn": { "base": null, "refs": { "CreateInstanceRequest$kmsKeyArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.
", "Instance$kmsKeyArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.
" } }, "ListDataIntegrationFlowsRequest": { "base": "The request parameters for ListDataIntegrationFlows.
", "refs": { } }, "ListDataIntegrationFlowsResponse": { "base": "The response parameters for ListDataIntegrationFlows.
", "refs": { } }, "ListDataLakeDatasetsRequest": { "base": "The request parameters of ListDataLakeDatasets.
", "refs": { } }, "ListDataLakeDatasetsResponse": { "base": "The response parameters of ListDataLakeDatasets.
", "refs": { } }, "ListInstancesRequest": { "base": "The request parameters for ListInstances.
", "refs": { } }, "ListInstancesResponse": { "base": "The response parameters for ListInstances.
", "refs": { } }, "ListTagsForResourceRequest": { "base": "The request parameters of ListTagsForResource.
", "refs": { } }, "ListTagsForResourceResponse": { "base": "The response parameters of ListTagsForResource.
", "refs": { } }, "ResourceNotFoundException": { "base": "Request references a resource which does not exist.
", "refs": { } }, "S3BucketName": { "base": null, "refs": { "DataIntegrationFlowS3SourceConfiguration$bucketName": "The bucketName of the S3 source objects.
", "DataIntegrationFlowS3TargetConfiguration$bucketName": "The bucketName of the S3 target objects.
" } }, "SendDataIntegrationEventRequest": { "base": "The request parameters for SendDataIntegrationEvent.
", "refs": { } }, "SendDataIntegrationEventResponse": { "base": "The response parameters for SendDataIntegrationEvent.
", "refs": { } }, "ServiceQuotaExceededException": { "base": "Request would cause a service quota to be exceeded.
", "refs": { } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "BillOfMaterialsImportJob$message": "When the BillOfMaterialsImportJob has reached a terminal state, there will be a message.
", "ConflictException$message": null, "Instance$errorMessage": "The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
", "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "SyntheticTimestamp_epoch_seconds": { "base": null, "refs": { "SendDataIntegrationEventRequest$eventTimestamp": "The event timestamp (in epoch seconds).
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The list of tag keys to be deleted for an Amazon Web Services Supply Chain resource.
" } }, "TagMap": { "base": null, "refs": { "CreateDataIntegrationFlowRequest$tags": "The tags of the DataIntegrationFlow to be created
", "CreateDataLakeDatasetRequest$tags": "The tags of the dataset.
", "CreateInstanceRequest$tags": "The Amazon Web Services tags of an instance to be created.
", "ListTagsForResourceResponse$tags": "The tags added to an Amazon Web Services Supply Chain resource.
", "TagResourceRequest$tags": "The tags of the Amazon Web Services Supply chain resource to be created.
" } }, "TagResourceRequest": { "base": "The request parameters of TagResource.
", "refs": { } }, "TagResourceResponse": { "base": "The response parameters for TagResource.
", "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "ThrottlingException": { "base": "Request was denied due to request throttling.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "DataIntegrationFlow$createdTime": "The DataIntegrationFlow creation timestamp.
", "DataIntegrationFlow$lastModifiedTime": "The DataIntegrationFlow last modified timestamp.
", "DataLakeDataset$createdTime": "The creation time of the dataset.
", "DataLakeDataset$lastModifiedTime": "The last modified time of the dataset.
", "Instance$createdTime": "The instance creation timestamp.
", "Instance$lastModifiedTime": "The instance last modified timestamp.
" } }, "UUID": { "base": null, "refs": { "BillOfMaterialsImportJob$instanceId": "The BillOfMaterialsImportJob instanceId.
", "BillOfMaterialsImportJob$jobId": "The BillOfMaterialsImportJob jobId.
", "CreateBillOfMaterialsImportJobRequest$instanceId": "The AWS Supply Chain instance identifier.
", "CreateBillOfMaterialsImportJobResponse$jobId": "The new BillOfMaterialsImportJob identifier.
", "CreateDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "CreateDataIntegrationFlowResponse$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "CreateDataLakeDatasetRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DataIntegrationFlow$instanceId": "The DataIntegrationFlow instance ID.
", "DataLakeDataset$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataIntegrationFlowResponse$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataLakeDatasetRequest$instanceId": "The AWS Supply Chain instance identifier.
", "DeleteDataLakeDatasetResponse$instanceId": "The AWS Supply Chain instance identifier.
", "DeleteInstanceRequest$instanceId": "The AWS Supply Chain instance identifier.
", "GetBillOfMaterialsImportJobRequest$instanceId": "The AWS Supply Chain instance identifier.
", "GetBillOfMaterialsImportJobRequest$jobId": "The BillOfMaterialsImportJob identifier.
", "GetDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "GetDataLakeDatasetRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "GetInstanceRequest$instanceId": "The AWS Supply Chain instance identifier
", "Instance$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "ListDataIntegrationFlowsRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "ListDataLakeDatasetsRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "SendDataIntegrationEventRequest$instanceId": "The AWS Supply Chain instance identifier.
", "SendDataIntegrationEventResponse$eventId": "The unique event identifier.
", "UpdateDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "UpdateDataLakeDatasetRequest$instanceId": "The Amazon Web Services Chain instance identifier.
", "UpdateInstanceRequest$instanceId": "The AWS Supply Chain instance identifier.
" } }, "UntagResourceRequest": { "base": "The request parameters of UntagResource.
", "refs": { } }, "UntagResourceResponse": { "base": "The response parameters of UntagResource.
", "refs": { } }, "UpdateDataIntegrationFlowRequest": { "base": "The request parameters for UpdateDataIntegrationFlow.
", "refs": { } }, "UpdateDataIntegrationFlowResponse": { "base": "The response parameters for UpdateDataIntegrationFlow.
", "refs": { } }, "UpdateDataLakeDatasetRequest": { "base": "The request parameters of UpdateDataLakeDataset.
", "refs": { } }, "UpdateDataLakeDatasetResponse": { "base": "The response parameters of UpdateDataLakeDataset.
", "refs": { } }, "UpdateInstanceRequest": { "base": "The request parameters for UpdateInstance.
", "refs": { } }, "UpdateInstanceResponse": { "base": "The response parameters for UpdateInstance.
", "refs": { } }, "ValidationException": { "base": "The input does not satisfy the constraints specified by an AWS service.
", "refs": { } } } }