feat(client-supplychain): API doc updates, and also support showing error message on a failed instance

awstools · awstools · commit 08bfafb93d7e · 2024-10-25T18:16:09.000Z
diff --git a/clients/client-supplychain/README.md b/clients/client-supplychain/README.md
@@ -16,7 +16,7 @@ All AWS Supply chain API operations are Amazon-authenticated and certificate-sig
 
 ## Installing
 
-To install the this package, simply type add or install @aws-sdk/client-supplychain
+To install this package, simply type add or install @aws-sdk/client-supplychain
 using your favorite package manager:
 
 - `npm install @aws-sdk/client-supplychain`
diff --git a/clients/client-supplychain/src/commands/CreateDataIntegrationFlowCommand.ts b/clients/client-supplychain/src/commands/CreateDataIntegrationFlowCommand.ts
@@ -28,7 +28,7 @@ export interface CreateDataIntegrationFlowCommandInput extends CreateDataIntegra
 export interface CreateDataIntegrationFlowCommandOutput extends CreateDataIntegrationFlowResponse, __MetadataBearer {}
 
 /**
- * <p>Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface CreateDataLakeDatasetCommandInput extends CreateDataLakeDataset
 export interface CreateDataLakeDatasetCommandOutput extends CreateDataLakeDatasetResponse, __MetadataBearer {}
 
 /**
- * <p>Create a data lake dataset.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,8 @@ export interface CreateInstanceCommandInput extends CreateInstanceRequest {}
 export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p>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.</p>
+ *          <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface DeleteDataIntegrationFlowCommandInput extends DeleteDataIntegra
 export interface DeleteDataIntegrationFlowCommandOutput extends DeleteDataIntegrationFlowResponse, __MetadataBearer {}
 
 /**
- * <p>Delete the DataIntegrationFlow.</p>
+ * <p>Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.</p>
  * @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
@@ -28,7 +28,7 @@ export interface DeleteDataLakeDatasetCommandInput extends DeleteDataLakeDataset
 export interface DeleteDataLakeDatasetCommandOutput extends DeleteDataLakeDatasetResponse, __MetadataBearer {}
 
 /**
- * <p>Delete a data lake dataset.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,9 @@ export interface DeleteInstanceCommandInput extends DeleteInstanceRequest {}
 export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p>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.</p>
+ *          <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface GetDataIntegrationFlowCommandInput extends GetDataIntegrationFl
 export interface GetDataIntegrationFlowCommandOutput extends GetDataIntegrationFlowResponse, __MetadataBearer {}
 
 /**
- * <p>View the DataIntegrationFlow details.</p>
+ * <p>Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.</p>
  * @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
@@ -28,7 +28,7 @@ export interface GetDataLakeDatasetCommandInput extends GetDataLakeDatasetReques
 export interface GetDataLakeDatasetCommandOutput extends GetDataLakeDatasetResponse, __MetadataBearer {}
 
 /**
- * <p>Get a data lake dataset.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface GetInstanceCommandInput extends GetInstanceRequest {}
 export interface GetInstanceCommandOutput extends GetInstanceResponse, __MetadataBearer {}
 
 /**
- * <p>Get the AWS Supply Chain instance details.</p>
+ * <p>Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.</p>
  * @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
@@ -28,7 +28,7 @@ export interface ListDataIntegrationFlowsCommandInput extends ListDataIntegratio
 export interface ListDataIntegrationFlowsCommandOutput extends ListDataIntegrationFlowsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists all the DataIntegrationFlows in a paginated way.</p>
+ * <p>Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.</p>
  * @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
@@ -28,7 +28,7 @@ export interface ListDataLakeDatasetsCommandInput extends ListDataLakeDatasetsRe
 export interface ListDataLakeDatasetsCommandOutput extends ListDataLakeDatasetsResponse, __MetadataBearer {}
 
 /**
- * <p>List the data lake datasets for a specific instance and name space.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface ListInstancesCommandInput extends ListInstancesRequest {}
 export interface ListInstancesCommandOutput extends ListInstancesResponse, __MetadataBearer {}
 
 /**
- * <p>List all the AWS Supply Chain instances in a paginated way.</p>
+ * <p>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).</p>
  * @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
@@ -28,7 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}
 
 /**
- * <p>List all the tags for an Amazon Web ServicesSupply Chain resource.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,8 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}
 
 /**
- * <p>Create tags for an Amazon Web Services Supply chain resource.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,8 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}
 
 /**
- * <p>Delete tags for an Amazon Web Services Supply chain resource.</p>
+ * <p>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. </p>
  * @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
@@ -28,7 +28,7 @@ export interface UpdateDataIntegrationFlowCommandInput extends UpdateDataIntegra
 export interface UpdateDataIntegrationFlowCommandOutput extends UpdateDataIntegrationFlowResponse, __MetadataBearer {}
 
 /**
- * <p>Update the DataIntegrationFlow.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface UpdateDataLakeDatasetCommandInput extends UpdateDataLakeDataset
 export interface UpdateDataLakeDatasetCommandOutput extends UpdateDataLakeDatasetResponse, __MetadataBearer {}
 
 /**
- * <p>Update a data lake dataset.</p>
+ * <p>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.</p>
  * @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
@@ -28,7 +28,7 @@ export interface UpdateInstanceCommandInput extends UpdateInstanceRequest {}
 export interface UpdateInstanceCommandOutput extends UpdateInstanceResponse, __MetadataBearer {}
 
 /**
- * <p>Update the instance.</p>
+ * <p>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.</p>
  * @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
@@ -864,6 +864,12 @@ export interface Instance {
    */
   state: InstanceState | undefined;
 
+  /**
+   * <p>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.</p>
+   * @public
+   */
+  errorMessage?: string;
+
   /**
    * <p>The WebApp DNS domain name of the instance.</p>
    * @public
diff --git 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
