Skip to content

Commit 9a500a0

Browse files
author
AWS
committed
AWS Supply Chain Update: API doc updates, and also support showing error message on a failed instance
1 parent 6c7c681 commit 9a500a0

File tree

2 files changed

+28
-18
lines changed

2 files changed

+28
-18
lines changed

‎.changes/next-release/feature-AWSSupplyChain-67db570.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Supply Chain",
4+
"contributor": "",
5+
"description": "API doc updates, and also support showing error message on a failed instance"
6+
}

‎services/supplychain/src/main/resources/codegen-resources/service-2.json

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
{"shape":"InternalServerException"},
5353
{"shape":"ConflictException"}
5454
],
55-
"documentation":"<p>Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.</p>",
55+
"documentation":"<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>",
5656
"idempotent":true
5757
},
5858
"CreateDataLakeDataset":{
@@ -73,7 +73,7 @@
7373
{"shape":"InternalServerException"},
7474
{"shape":"ConflictException"}
7575
],
76-
"documentation":"<p>Create a data lake dataset.</p>",
76+
"documentation":"<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>",
7777
"idempotent":true
7878
},
7979
"CreateInstance":{
@@ -94,7 +94,7 @@
9494
{"shape":"InternalServerException"},
9595
{"shape":"ConflictException"}
9696
],
97-
"documentation":"<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>",
97+
"documentation":"<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>",
9898
"idempotent":true
9999
},
100100
"DeleteDataIntegrationFlow":{
@@ -115,7 +115,7 @@
115115
{"shape":"InternalServerException"},
116116
{"shape":"ConflictException"}
117117
],
118-
"documentation":"<p>Delete the DataIntegrationFlow.</p>",
118+
"documentation":"<p>Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.</p>",
119119
"idempotent":true
120120
},
121121
"DeleteDataLakeDataset":{
@@ -136,7 +136,7 @@
136136
{"shape":"InternalServerException"},
137137
{"shape":"ConflictException"}
138138
],
139-
"documentation":"<p>Delete a data lake dataset.</p>",
139+
"documentation":"<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>",
140140
"idempotent":true
141141
},
142142
"DeleteInstance":{
@@ -157,7 +157,7 @@
157157
{"shape":"InternalServerException"},
158158
{"shape":"ConflictException"}
159159
],
160-
"documentation":"<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>",
160+
"documentation":"<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>",
161161
"idempotent":true
162162
},
163163
"GetBillOfMaterialsImportJob":{
@@ -198,7 +198,7 @@
198198
{"shape":"InternalServerException"},
199199
{"shape":"ConflictException"}
200200
],
201-
"documentation":"<p>View the DataIntegrationFlow details.</p>"
201+
"documentation":"<p>Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.</p>"
202202
},
203203
"GetDataLakeDataset":{
204204
"name":"GetDataLakeDataset",
@@ -218,7 +218,7 @@
218218
{"shape":"InternalServerException"},
219219
{"shape":"ConflictException"}
220220
],
221-
"documentation":"<p>Get a data lake dataset.</p>"
221+
"documentation":"<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>"
222222
},
223223
"GetInstance":{
224224
"name":"GetInstance",
@@ -238,7 +238,7 @@
238238
{"shape":"InternalServerException"},
239239
{"shape":"ConflictException"}
240240
],
241-
"documentation":"<p>Get the AWS Supply Chain instance details.</p>"
241+
"documentation":"<p>Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.</p>"
242242
},
243243
"ListDataIntegrationFlows":{
244244
"name":"ListDataIntegrationFlows",
@@ -258,7 +258,7 @@
258258
{"shape":"InternalServerException"},
259259
{"shape":"ConflictException"}
260260
],
261-
"documentation":"<p>Lists all the DataIntegrationFlows in a paginated way.</p>"
261+
"documentation":"<p>Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.</p>"
262262
},
263263
"ListDataLakeDatasets":{
264264
"name":"ListDataLakeDatasets",
@@ -278,7 +278,7 @@
278278
{"shape":"InternalServerException"},
279279
{"shape":"ConflictException"}
280280
],
281-
"documentation":"<p>List the data lake datasets for a specific instance and name space.</p>"
281+
"documentation":"<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>"
282282
},
283283
"ListInstances":{
284284
"name":"ListInstances",
@@ -298,7 +298,7 @@
298298
{"shape":"InternalServerException"},
299299
{"shape":"ConflictException"}
300300
],
301-
"documentation":"<p>List all the AWS Supply Chain instances in a paginated way.</p>"
301+
"documentation":"<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>"
302302
},
303303
"ListTagsForResource":{
304304
"name":"ListTagsForResource",
@@ -318,7 +318,7 @@
318318
{"shape":"InternalServerException"},
319319
{"shape":"ConflictException"}
320320
],
321-
"documentation":"<p>List all the tags for an Amazon Web ServicesSupply Chain resource.</p>"
321+
"documentation":"<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>"
322322
},
323323
"SendDataIntegrationEvent":{
324324
"name":"SendDataIntegrationEvent",
@@ -359,7 +359,7 @@
359359
{"shape":"InternalServerException"},
360360
{"shape":"ConflictException"}
361361
],
362-
"documentation":"<p>Create tags for an Amazon Web Services Supply chain resource.</p>"
362+
"documentation":"<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>"
363363
},
364364
"UntagResource":{
365365
"name":"UntagResource",
@@ -379,7 +379,7 @@
379379
{"shape":"InternalServerException"},
380380
{"shape":"ConflictException"}
381381
],
382-
"documentation":"<p>Delete tags for an Amazon Web Services Supply chain resource.</p>",
382+
"documentation":"<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>",
383383
"idempotent":true
384384
},
385385
"UpdateDataIntegrationFlow":{
@@ -400,7 +400,7 @@
400400
{"shape":"InternalServerException"},
401401
{"shape":"ConflictException"}
402402
],
403-
"documentation":"<p>Update the DataIntegrationFlow.</p>"
403+
"documentation":"<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>"
404404
},
405405
"UpdateDataLakeDataset":{
406406
"name":"UpdateDataLakeDataset",
@@ -420,7 +420,7 @@
420420
{"shape":"InternalServerException"},
421421
{"shape":"ConflictException"}
422422
],
423-
"documentation":"<p>Update a data lake dataset.</p>"
423+
"documentation":"<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>"
424424
},
425425
"UpdateInstance":{
426426
"name":"UpdateInstance",
@@ -440,7 +440,7 @@
440440
{"shape":"InternalServerException"},
441441
{"shape":"ConflictException"}
442442
],
443-
"documentation":"<p>Update the instance.</p>"
443+
"documentation":"<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>"
444444
}
445445
},
446446
"shapes":{
@@ -1469,6 +1469,10 @@
14691469
"shape":"InstanceState",
14701470
"documentation":"<p>The state of the instance.</p>"
14711471
},
1472+
"errorMessage":{
1473+
"shape":"String",
1474+
"documentation":"<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>"
1475+
},
14721476
"webAppDnsDomain":{
14731477
"shape":"InstanceWebAppDnsDomain",
14741478
"documentation":"<p>The WebApp DNS domain name of the instance.</p>"

0 commit comments

Comments
 (0)