Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/CreateDataLakeDatasetCommand.ts b/clients/client-supplychain/src/commands/CreateDataLakeDatasetCommand.ts index e5ff691730cf..142e9d9983ca 100644 --- a/clients/client-supplychain/src/commands/CreateDataLakeDatasetCommand.ts +++ b/clients/client-supplychain/src/commands/CreateDataLakeDatasetCommand.ts @@ -28,7 +28,7 @@ export interface CreateDataLakeDatasetCommandInput extends CreateDataLakeDataset export interface CreateDataLakeDatasetCommandOutput extends CreateDataLakeDatasetResponse, __MetadataBearer {} /** - *Create a data lake dataset.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/CreateInstanceCommand.ts b/clients/client-supplychain/src/commands/CreateInstanceCommand.ts index d2f5727ab8cc..bcee0923270c 100644 --- a/clients/client-supplychain/src/commands/CreateInstanceCommand.ts +++ b/clients/client-supplychain/src/commands/CreateInstanceCommand.ts @@ -28,7 +28,8 @@ export interface CreateInstanceCommandInput extends CreateInstanceRequest {} export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __MetadataBearer {} /** - *Create a new instance for AWS Supply Chain. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, with 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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -51,6 +52,7 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __M * // instanceId: "STRING_VALUE", // required * // awsAccountId: "STRING_VALUE", // required * // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required + * // errorMessage: "STRING_VALUE", * // webAppDnsDomain: "STRING_VALUE", * // createdTime: new Date("TIMESTAMP"), * // lastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-supplychain/src/commands/DeleteDataIntegrationFlowCommand.ts b/clients/client-supplychain/src/commands/DeleteDataIntegrationFlowCommand.ts index 0a30cdc32e16..d9d0378dc55a 100644 --- a/clients/client-supplychain/src/commands/DeleteDataIntegrationFlowCommand.ts +++ b/clients/client-supplychain/src/commands/DeleteDataIntegrationFlowCommand.ts @@ -28,7 +28,7 @@ export interface DeleteDataIntegrationFlowCommandInput extends DeleteDataIntegra export interface DeleteDataIntegrationFlowCommandOutput extends DeleteDataIntegrationFlowResponse, __MetadataBearer {} /** - *Delete the DataIntegrationFlow.
+ *Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/DeleteDataLakeDatasetCommand.ts b/clients/client-supplychain/src/commands/DeleteDataLakeDatasetCommand.ts index 5719493142d2..3be729a079b3 100644 --- a/clients/client-supplychain/src/commands/DeleteDataLakeDatasetCommand.ts +++ b/clients/client-supplychain/src/commands/DeleteDataLakeDatasetCommand.ts @@ -28,7 +28,7 @@ export interface DeleteDataLakeDatasetCommandInput extends DeleteDataLakeDataset export interface DeleteDataLakeDatasetCommandOutput extends DeleteDataLakeDatasetResponse, __MetadataBearer {} /** - *Delete a data lake dataset.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/DeleteInstanceCommand.ts b/clients/client-supplychain/src/commands/DeleteInstanceCommand.ts index 4fc9d0413aad..71a2ce6e3e23 100644 --- a/clients/client-supplychain/src/commands/DeleteInstanceCommand.ts +++ b/clients/client-supplychain/src/commands/DeleteInstanceCommand.ts @@ -28,7 +28,9 @@ export interface DeleteInstanceCommandInput extends DeleteInstanceRequest {} export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __MetadataBearer {} /** - *Delete the instance. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS 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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -45,6 +47,7 @@ export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __M * // instanceId: "STRING_VALUE", // required * // awsAccountId: "STRING_VALUE", // required * // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required + * // errorMessage: "STRING_VALUE", * // webAppDnsDomain: "STRING_VALUE", * // createdTime: new Date("TIMESTAMP"), * // lastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-supplychain/src/commands/GetDataIntegrationFlowCommand.ts b/clients/client-supplychain/src/commands/GetDataIntegrationFlowCommand.ts index cc2caaf733df..4f18b2dde6bd 100644 --- a/clients/client-supplychain/src/commands/GetDataIntegrationFlowCommand.ts +++ b/clients/client-supplychain/src/commands/GetDataIntegrationFlowCommand.ts @@ -28,7 +28,7 @@ export interface GetDataIntegrationFlowCommandInput extends GetDataIntegrationFl export interface GetDataIntegrationFlowCommandOutput extends GetDataIntegrationFlowResponse, __MetadataBearer {} /** - *View the DataIntegrationFlow details.
+ *Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/GetDataLakeDatasetCommand.ts b/clients/client-supplychain/src/commands/GetDataLakeDatasetCommand.ts index c1249e754c0c..8f8595fb1b60 100644 --- a/clients/client-supplychain/src/commands/GetDataLakeDatasetCommand.ts +++ b/clients/client-supplychain/src/commands/GetDataLakeDatasetCommand.ts @@ -28,7 +28,7 @@ export interface GetDataLakeDatasetCommandInput extends GetDataLakeDatasetReques export interface GetDataLakeDatasetCommandOutput extends GetDataLakeDatasetResponse, __MetadataBearer {} /** - *Get a data lake dataset.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/GetInstanceCommand.ts b/clients/client-supplychain/src/commands/GetInstanceCommand.ts index 6ffe99518a71..adb3700e3fa8 100644 --- a/clients/client-supplychain/src/commands/GetInstanceCommand.ts +++ b/clients/client-supplychain/src/commands/GetInstanceCommand.ts @@ -28,7 +28,7 @@ export interface GetInstanceCommandInput extends GetInstanceRequest {} export interface GetInstanceCommandOutput extends GetInstanceResponse, __MetadataBearer {} /** - *Get the AWS Supply Chain instance details.
+ *Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -45,6 +45,7 @@ export interface GetInstanceCommandOutput extends GetInstanceResponse, __Metadat * // instanceId: "STRING_VALUE", // required * // awsAccountId: "STRING_VALUE", // required * // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required + * // errorMessage: "STRING_VALUE", * // webAppDnsDomain: "STRING_VALUE", * // createdTime: new Date("TIMESTAMP"), * // lastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-supplychain/src/commands/ListDataIntegrationFlowsCommand.ts b/clients/client-supplychain/src/commands/ListDataIntegrationFlowsCommand.ts index 541dcd6664e1..64fec76fd87d 100644 --- a/clients/client-supplychain/src/commands/ListDataIntegrationFlowsCommand.ts +++ b/clients/client-supplychain/src/commands/ListDataIntegrationFlowsCommand.ts @@ -28,7 +28,7 @@ export interface ListDataIntegrationFlowsCommandInput extends ListDataIntegratio export interface ListDataIntegrationFlowsCommandOutput extends ListDataIntegrationFlowsResponse, __MetadataBearer {} /** - *Lists all the DataIntegrationFlows in a paginated way.
+ *Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/ListDataLakeDatasetsCommand.ts b/clients/client-supplychain/src/commands/ListDataLakeDatasetsCommand.ts index 342df89f3397..ba5fca427c65 100644 --- a/clients/client-supplychain/src/commands/ListDataLakeDatasetsCommand.ts +++ b/clients/client-supplychain/src/commands/ListDataLakeDatasetsCommand.ts @@ -28,7 +28,7 @@ export interface ListDataLakeDatasetsCommandInput extends ListDataLakeDatasetsRe export interface ListDataLakeDatasetsCommandOutput extends ListDataLakeDatasetsResponse, __MetadataBearer {} /** - *List the data lake datasets for a specific instance and name space.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/ListInstancesCommand.ts b/clients/client-supplychain/src/commands/ListInstancesCommand.ts index 44dbe75f62b6..23ddd10fa8ad 100644 --- a/clients/client-supplychain/src/commands/ListInstancesCommand.ts +++ b/clients/client-supplychain/src/commands/ListInstancesCommand.ts @@ -28,7 +28,7 @@ export interface ListInstancesCommandInput extends ListInstancesRequest {} export interface ListInstancesCommandOutput extends ListInstancesResponse, __MetadataBearer {} /** - *List all the AWS Supply Chain instances in a paginated way.
+ *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).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,6 +53,7 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met * // instanceId: "STRING_VALUE", // required * // awsAccountId: "STRING_VALUE", // required * // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required + * // errorMessage: "STRING_VALUE", * // webAppDnsDomain: "STRING_VALUE", * // createdTime: new Date("TIMESTAMP"), * // lastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-supplychain/src/commands/ListTagsForResourceCommand.ts b/clients/client-supplychain/src/commands/ListTagsForResourceCommand.ts index b435f7a2f92a..b54c0796515e 100644 --- a/clients/client-supplychain/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-supplychain/src/commands/ListTagsForResourceCommand.ts @@ -28,7 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - *List all the tags for an Amazon Web ServicesSupply Chain resource.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/TagResourceCommand.ts b/clients/client-supplychain/src/commands/TagResourceCommand.ts index 7c291927750f..c82e835f4a63 100644 --- a/clients/client-supplychain/src/commands/TagResourceCommand.ts +++ b/clients/client-supplychain/src/commands/TagResourceCommand.ts @@ -28,7 +28,8 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *Create tags for an Amazon Web Services Supply chain resource.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/UntagResourceCommand.ts b/clients/client-supplychain/src/commands/UntagResourceCommand.ts index 7a957e73eedd..82582dbb3767 100644 --- a/clients/client-supplychain/src/commands/UntagResourceCommand.ts +++ b/clients/client-supplychain/src/commands/UntagResourceCommand.ts @@ -28,7 +28,8 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *Delete tags for an Amazon Web Services Supply chain resource.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/UpdateDataIntegrationFlowCommand.ts b/clients/client-supplychain/src/commands/UpdateDataIntegrationFlowCommand.ts index f839cd82e29d..69b3b490f6fb 100644 --- a/clients/client-supplychain/src/commands/UpdateDataIntegrationFlowCommand.ts +++ b/clients/client-supplychain/src/commands/UpdateDataIntegrationFlowCommand.ts @@ -28,7 +28,7 @@ export interface UpdateDataIntegrationFlowCommandInput extends UpdateDataIntegra export interface UpdateDataIntegrationFlowCommandOutput extends UpdateDataIntegrationFlowResponse, __MetadataBearer {} /** - *Update the DataIntegrationFlow.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/UpdateDataLakeDatasetCommand.ts b/clients/client-supplychain/src/commands/UpdateDataLakeDatasetCommand.ts index 522577a8c22b..87d35fe4c987 100644 --- a/clients/client-supplychain/src/commands/UpdateDataLakeDatasetCommand.ts +++ b/clients/client-supplychain/src/commands/UpdateDataLakeDatasetCommand.ts @@ -28,7 +28,7 @@ export interface UpdateDataLakeDatasetCommandInput extends UpdateDataLakeDataset export interface UpdateDataLakeDatasetCommandOutput extends UpdateDataLakeDatasetResponse, __MetadataBearer {} /** - *Update a data lake dataset.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-supplychain/src/commands/UpdateInstanceCommand.ts b/clients/client-supplychain/src/commands/UpdateInstanceCommand.ts index 38f7c2883396..67c2f35e324c 100644 --- a/clients/client-supplychain/src/commands/UpdateInstanceCommand.ts +++ b/clients/client-supplychain/src/commands/UpdateInstanceCommand.ts @@ -28,7 +28,7 @@ export interface UpdateInstanceCommandInput extends UpdateInstanceRequest {} export interface UpdateInstanceCommandOutput extends UpdateInstanceResponse, __MetadataBearer {} /** - *Update the instance.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -47,6 +47,7 @@ export interface UpdateInstanceCommandOutput extends UpdateInstanceResponse, __M * // instanceId: "STRING_VALUE", // required * // awsAccountId: "STRING_VALUE", // required * // state: "Initializing" || "Active" || "CreateFailed" || "DeleteFailed" || "Deleting" || "Deleted", // required + * // errorMessage: "STRING_VALUE", * // webAppDnsDomain: "STRING_VALUE", * // createdTime: new Date("TIMESTAMP"), * // lastModifiedTime: new Date("TIMESTAMP"), diff --git a/clients/client-supplychain/src/models/models_0.ts b/clients/client-supplychain/src/models/models_0.ts index 155b71254430..24aa5784baf5 100644 --- a/clients/client-supplychain/src/models/models_0.ts +++ b/clients/client-supplychain/src/models/models_0.ts @@ -864,6 +864,12 @@ export interface Instance { */ state: InstanceState | undefined; + /** + *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.
+ * @public + */ + errorMessage?: string; + /** *The WebApp DNS domain name of the instance.
* @public diff --git a/clients/client-supplychain/src/protocols/Aws_restJson1.ts b/clients/client-supplychain/src/protocols/Aws_restJson1.ts index e88fb0ca01b3..32c69bfdb56e 100644 --- a/clients/client-supplychain/src/protocols/Aws_restJson1.ts +++ b/clients/client-supplychain/src/protocols/Aws_restJson1.ts @@ -1291,6 +1291,7 @@ const de_Instance = (output: any, context: __SerdeContext): Instance => { return take(output, { awsAccountId: __expectString, createdTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + errorMessage: __expectString, instanceDescription: __expectString, instanceId: __expectString, instanceName: __expectString, diff --git a/codegen/sdk-codegen/aws-models/supplychain.json b/codegen/sdk-codegen/aws-models/supplychain.json index 3df514ed8fea..533841309c9c 100644 --- a/codegen/sdk-codegen/aws-models/supplychain.json +++ b/codegen/sdk-codegen/aws-models/supplychain.json @@ -304,7 +304,7 @@ } ], "traits": { - "smithy.api#documentation": "Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Successful CreateDataIntegrationFlow for s3 to dataset flow", @@ -498,7 +498,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a data lake dataset.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Create an AWS Supply Chain inbound order dataset", @@ -860,7 +860,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new instance for AWS Supply Chain. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, with 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.
", + "smithy.api#documentation": "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.
\nThis 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.
", "smithy.api#examples": [ { "title": "Successful CreateInstance request with all input data", @@ -1941,7 +1941,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete the DataIntegrationFlow.
", + "smithy.api#documentation": "Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", "smithy.api#examples": [ { "title": "Successful DeleteDataIntegrationFlow", @@ -2037,7 +2037,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a data lake dataset.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Delete an AWS Supply Chain inbound_order dataset", @@ -2163,7 +2163,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete the instance. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS 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.
", + "smithy.api#documentation": "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.
\nThis 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 \n the instance creation process. You can use the GetInstance action to check the instance status.
", "smithy.api#examples": [ { "title": "Successful DeleteInstance request", @@ -3107,7 +3107,7 @@ } ], "traits": { - "smithy.api#documentation": "View the DataIntegrationFlow details.
", + "smithy.api#documentation": "Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", "smithy.api#examples": [ { "title": "Successful GetDataIntegrationFlow", @@ -3223,7 +3223,7 @@ } ], "traits": { - "smithy.api#documentation": "Get a data lake dataset.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Get properties of an existing AWS Supply Chain inbound order dataset", @@ -3528,7 +3528,7 @@ } ], "traits": { - "smithy.api#documentation": "Get the AWS Supply Chain instance details.
", + "smithy.api#documentation": "Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
", "smithy.api#examples": [ { "title": "Successful GetInstance request", @@ -3548,6 +3548,26 @@ "versionNumber": 2.0 } } + }, + { + "title": "Successful GetInstance request with error message", + "input": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793" + }, + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "CreateFailed", + "errorMessage": "Access denied when attempting to create an S3 bucket. Please correct your IAM policy and try again.", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 + } + } } ], "smithy.api#http": { @@ -3617,6 +3637,12 @@ "smithy.api#required": {} } }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "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.
" + } + }, "webAppDnsDomain": { "target": "com.amazonaws.supplychain#InstanceWebAppDnsDomain", "traits": { @@ -3738,6 +3764,9 @@ "state": { "target": "com.amazonaws.supplychain#InstanceState" }, + "errorMessage": { + "target": "smithy.api#String" + }, "createdTime": { "target": "smithy.api#Timestamp" }, @@ -3883,7 +3912,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the DataIntegrationFlows in a paginated way.
", + "smithy.api#documentation": "Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
", "smithy.api#examples": [ { "title": "Successful ListDataIntegrationFlow", @@ -4052,7 +4081,7 @@ } ], "traits": { - "smithy.api#documentation": "List the data lake datasets for a specific instance and name space.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "List AWS Supply Chain datasets", @@ -4401,7 +4430,7 @@ } ], "traits": { - "smithy.api#documentation": "List all the AWS Supply Chain instances in a paginated way.
", + "smithy.api#documentation": "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).
", "smithy.api#examples": [ { "title": "Successful ListInstance request with no input data", @@ -4597,7 +4626,7 @@ } ], "traits": { - "smithy.api#documentation": "List all the tags for an Amazon Web ServicesSupply Chain resource.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Successful ListTagsForResource", @@ -5056,7 +5085,7 @@ } ], "traits": { - "smithy.api#documentation": "Create tags for an Amazon Web Services Supply chain resource.
", + "smithy.api#documentation": "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 \n 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.
", "smithy.api#examples": [ { "title": "Successful TagResource", @@ -5169,7 +5198,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete tags for an Amazon Web Services Supply chain resource.
", + "smithy.api#documentation": "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 \n created during the data ingestion process in the AWS Supply Chain datasets.
", "smithy.api#examples": [ { "title": "Successful UntagResource", @@ -5247,7 +5276,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the DataIntegrationFlow.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Successful UpdateDataIntegrationFlow for s3 to dataset flow to update SQL transformation", @@ -5473,7 +5502,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a data lake dataset.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Update description of an existing AWS Supply Chain inbound order dataset", @@ -5785,7 +5814,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the instance.
", + "smithy.api#documentation": "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.
", "smithy.api#examples": [ { "title": "Successful UpdateInstance request",