Skip to content

Commit 0cdf2e3

Browse files
author
awstools
committedJan 6, 2025
feat(client-supplychain): Allow vanity DNS domain when creating a new ASC instance
1 parent 997e37d commit 0cdf2e3

File tree

8 files changed

+52
-35
lines changed

8 files changed

+52
-35
lines changed
 

‎clients/client-supplychain/src/commands/CreateInstanceCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __M
4040
* instanceName: "STRING_VALUE",
4141
* instanceDescription: "STRING_VALUE",
4242
* kmsKeyArn: "STRING_VALUE",
43+
* webAppDnsDomain: "STRING_VALUE",
4344
* tags: { // TagMap
4445
* "<keys>": "STRING_VALUE",
4546
* },

‎clients/client-supplychain/src/commands/DeleteInstanceCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ export interface DeleteInstanceCommandOutput extends DeleteInstanceResponse, __M
2929

3030
/**
3131
* <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>
32-
* <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
33-
* the instance creation process. You can use the GetInstance action to check the instance status.</p>
32+
* <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>
3433
* @example
3534
* Use a bare-bones client and the command you need to make an API call.
3635
* ```javascript

‎clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export interface SendDataIntegrationEventCommandInput extends SendDataIntegratio
3232
export interface SendDataIntegrationEventCommandOutput extends SendDataIntegrationEventResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>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.
36-
* New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.</p>
35+
* <p>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.</p>
3736
* @example
3837
* Use a bare-bones client and the command you need to make an API call.
3938
* ```javascript

‎clients/client-supplychain/src/commands/TagResourceCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {}
2828
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <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
32-
* 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>
31+
* <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>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

‎clients/client-supplychain/src/commands/UntagResourceCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
2828
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <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
32-
* created during the data ingestion process in the AWS Supply Chain datasets. </p>
31+
* <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>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

‎clients/client-supplychain/src/models/models_0.ts

+20-16
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ export interface CreateDataLakeDatasetRequest {
693693
name: string | undefined;
694694

695695
/**
696-
* <p>The custom schema of the data lake dataset and is only required when the name space is <i>default</i>.</p>
696+
* <p>The custom schema of the data lake dataset and is only required when the name space is <b>default</b>.</p>
697697
* @public
698698
*/
699699
schema?: DataLakeDatasetSchema | undefined;
@@ -810,6 +810,12 @@ export interface CreateInstanceRequest {
810810
*/
811811
kmsKeyArn?: string | undefined;
812812

813+
/**
814+
* <p>The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens.</p>
815+
* @public
816+
*/
817+
webAppDnsDomain?: string | undefined;
818+
813819
/**
814820
* <p>The Amazon Web Services tags of an instance to be created.</p>
815821
* @public
@@ -970,8 +976,7 @@ export interface SendDataIntegrationEventRequest {
970976
eventType: DataIntegrationEventType | undefined;
971977

972978
/**
973-
* <p>The data payload of the event. For more information on the data schema to use, see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">Data entities supported in AWS Supply Chain
974-
* </a>.</p>
979+
* <p>The data payload of the event. For more information on the data schema to use, see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">Data entities supported in AWS Supply Chain</a>.</p>
975980
* @public
976981
*/
977982
data: string | undefined;
@@ -1223,24 +1228,23 @@ export interface DeleteDataLakeDatasetRequest {
12231228
instanceId: string | undefined;
12241229

12251230
/**
1226-
* <p>The namespace of the dataset. The available values are:</p>
1231+
* <p>The name space of the dataset. The available values are:</p>
12271232
* <ul>
12281233
* <li>
1229-
* <p>asc: for <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">
1230-
* AWS Supply Chain supported datasets
1231-
* </a>.</p>
1234+
* <p>
1235+
* <b>asc</b> - For information on the Amazon Web Services Supply Chain supported datasets see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>
12321236
* </li>
12331237
* <li>
1234-
* <p>default: for datasets with custom user-defined schemas.</p>
1238+
* <p>
1239+
* <b>default</b> - For datasets with custom user-defined schemas.</p>
12351240
* </li>
12361241
* </ul>
12371242
* @public
12381243
*/
12391244
namespace: string | undefined;
12401245

12411246
/**
1242-
* <p>The name of the dataset. If the namespace is <i>asc</i>, the name must be one of the supported <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">data entities
1243-
* </a>.</p>
1247+
* <p>The name of the dataset. For <b>asc</b> name space, the name must be one of the supported data entities under <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>
12441248
* @public
12451249
*/
12461250
name: string | undefined;
@@ -1258,7 +1262,7 @@ export interface DeleteDataLakeDatasetResponse {
12581262
instanceId: string | undefined;
12591263

12601264
/**
1261-
* <p>The namespace of deleted dataset.</p>
1265+
* <p>The name space of deleted dataset.</p>
12621266
* @public
12631267
*/
12641268
namespace: string | undefined;
@@ -1328,15 +1332,15 @@ export interface ListDataLakeDatasetsRequest {
13281332
instanceId: string | undefined;
13291333

13301334
/**
1331-
* <p>The namespace of the dataset. The available values are:</p>
1335+
* <p>The name space of the dataset. The available values are:</p>
13321336
* <ul>
13331337
* <li>
1334-
* <p>asc: for <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">
1335-
* AWS Supply Chain supported datasets
1336-
* </a>.</p>
1338+
* <p>
1339+
* <b>asc</b> - For information on the Amazon Web Services Supply Chain supported datasets see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>
13371340
* </li>
13381341
* <li>
1339-
* <p>default: for datasets with custom user-defined schemas.</p>
1342+
* <p>
1343+
* <b>default</b> - For datasets with custom user-defined schemas.</p>
13401344
* </li>
13411345
* </ul>
13421346
* @public

‎clients/client-supplychain/src/protocols/Aws_restJson1.ts

+1
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ export const se_CreateInstanceCommand = async (
209209
instanceName: [],
210210
kmsKeyArn: [],
211211
tags: (_) => _json(_),
212+
webAppDnsDomain: [],
212213
})
213214
);
214215
b.m("POST").h(headers).b(body);

‎codegen/sdk-codegen/aws-models/supplychain.json

+26-11
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@
792792
"schema": {
793793
"target": "com.amazonaws.supplychain#DataLakeDatasetSchema",
794794
"traits": {
795-
"smithy.api#documentation": "<p>The custom schema of the data lake dataset and is only required when the name space is <i>default</i>.</p>"
795+
"smithy.api#documentation": "<p>The custom schema of the data lake dataset and is only required when the name space is <b>default</b>.</p>"
796796
}
797797
},
798798
"description": {
@@ -931,6 +931,12 @@
931931
"smithy.api#documentation": "<p>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.</p>"
932932
}
933933
},
934+
"webAppDnsDomain": {
935+
"target": "com.amazonaws.supplychain#InstanceWebAppDnsDomain",
936+
"traits": {
937+
"smithy.api#documentation": "<p>The DNS subdomain of the web app. This would be \"example\" in the URL \"example.scn.global.on.aws\". You can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only include alphanumeric characters and hyphens.</p>"
938+
}
939+
},
934940
"tags": {
935941
"target": "com.amazonaws.supplychain#TagMap",
936942
"traits": {
@@ -1356,6 +1362,9 @@
13561362
"traits": {
13571363
"aws.api#arn": {
13581364
"template": "instance/{instanceId}/data-integration-flows/{name}"
1365+
},
1366+
"aws.cloudformation#cfnResource": {
1367+
"name": "DataIntegrationFlow"
13591368
}
13601369
}
13611370
},
@@ -1793,6 +1802,9 @@
17931802
"aws.api#arn": {
17941803
"template": "instance/{instanceId}/namespaces/{namespace}/datasets/{name}"
17951804
},
1805+
"aws.cloudformation#cfnResource": {
1806+
"name": "DataLakeDataset"
1807+
},
17961808
"smithy.api#noReplace": {}
17971809
}
17981810
},
@@ -2088,15 +2100,15 @@
20882100
"namespace": {
20892101
"target": "com.amazonaws.supplychain#DataLakeDatasetNamespace",
20902102
"traits": {
2091-
"smithy.api#documentation": "<p>The namespace of the dataset. The available values are:</p>\n <ul>\n <li>\n <p>asc: for <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">\n AWS Supply Chain supported datasets\n </a>.</p>\n </li>\n <li>\n <p>default: for datasets with custom user-defined schemas.</p>\n </li>\n </ul>",
2103+
"smithy.api#documentation": "<p>The name space of the dataset. The available values are:</p>\n <ul>\n <li>\n <p>\n <b>asc</b> - For information on the Amazon Web Services Supply Chain supported datasets see <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>\n </li>\n <li>\n <p>\n <b>default</b> - For datasets with custom user-defined schemas.</p>\n </li>\n </ul>",
20922104
"smithy.api#httpLabel": {},
20932105
"smithy.api#required": {}
20942106
}
20952107
},
20962108
"name": {
20972109
"target": "com.amazonaws.supplychain#DataLakeDatasetName",
20982110
"traits": {
2099-
"smithy.api#documentation": "<p>The name of the dataset. If the namespace is <i>asc</i>, the name must be one of the supported <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">data entities\n </a>.</p>",
2111+
"smithy.api#documentation": "<p>The name of the dataset. For <b>asc</b> name space, the name must be one of the supported data entities under <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>",
21002112
"smithy.api#httpLabel": {},
21012113
"smithy.api#required": {}
21022114
}
@@ -2120,7 +2132,7 @@
21202132
"namespace": {
21212133
"target": "com.amazonaws.supplychain#DataLakeDatasetNamespace",
21222134
"traits": {
2123-
"smithy.api#documentation": "<p>The namespace of deleted dataset.</p>",
2135+
"smithy.api#documentation": "<p>The name space of deleted dataset.</p>",
21242136
"smithy.api#required": {}
21252137
}
21262138
},
@@ -2163,7 +2175,7 @@
21632175
}
21642176
],
21652177
"traits": {
2166-
"smithy.api#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>\n <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 \n the instance creation process. You can use the GetInstance action to check the instance status.</p>",
2178+
"smithy.api#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>\n <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>",
21672179
"smithy.api#examples": [
21682180
{
21692181
"title": "Successful DeleteInstance request",
@@ -3804,6 +3816,9 @@
38043816
"traits": {
38053817
"aws.api#arn": {
38063818
"template": "instance/{instanceId}"
3819+
},
3820+
"aws.cloudformation#cfnResource": {
3821+
"name": "Instance"
38073822
}
38083823
}
38093824
},
@@ -3863,7 +3878,7 @@
38633878
"com.amazonaws.supplychain#InstanceWebAppDnsDomain": {
38643879
"type": "string",
38653880
"traits": {
3866-
"smithy.api#pattern": "^[A-Za-z0-9]+(.[A-Za-z0-9]+)+$"
3881+
"smithy.api#pattern": "^(?![-])[a-zA-Z0-9-]{1,62}[a-zA-Z0-9]$"
38673882
}
38683883
},
38693884
"com.amazonaws.supplychain#InternalServerException": {
@@ -4359,7 +4374,7 @@
43594374
"namespace": {
43604375
"target": "com.amazonaws.supplychain#DataLakeDatasetNamespace",
43614376
"traits": {
4362-
"smithy.api#documentation": "<p>The namespace of the dataset. The available values are:</p>\n <ul>\n <li>\n <p>asc: for <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">\n AWS Supply Chain supported datasets\n </a>.</p>\n </li>\n <li>\n <p>default: for datasets with custom user-defined schemas.</p>\n </li>\n </ul>",
4377+
"smithy.api#documentation": "<p>The name space of the dataset. The available values are:</p>\n <ul>\n <li>\n <p>\n <b>asc</b> - For information on the Amazon Web Services Supply Chain supported datasets see <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html</a>.</p>\n </li>\n <li>\n <p>\n <b>default</b> - For datasets with custom user-defined schemas.</p>\n </li>\n </ul>",
43634378
"smithy.api#httpLabel": {},
43644379
"smithy.api#required": {}
43654380
}
@@ -4736,7 +4751,7 @@
47364751
}
47374752
],
47384753
"traits": {
4739-
"smithy.api#documentation": "<p>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. \n New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.</p>",
4754+
"smithy.api#documentation": "<p>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.</p>",
47404755
"smithy.api#examples": [
47414756
{
47424757
"title": "Successful SendDataIntegrationEvent for inboundorder event type",
@@ -4963,7 +4978,7 @@
49634978
"data": {
49644979
"target": "com.amazonaws.supplychain#DataIntegrationEventData",
49654980
"traits": {
4966-
"smithy.api#documentation": "<p>The data payload of the event. For more information on the data schema to use, see <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">Data entities supported in AWS Supply Chain\n </a>.</p>",
4981+
"smithy.api#documentation": "<p>The data payload of the event. For more information on the data schema to use, see <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">Data entities supported in AWS Supply Chain</a>.</p>",
49674982
"smithy.api#required": {}
49684983
}
49694984
},
@@ -5085,7 +5100,7 @@
50855100
}
50865101
],
50875102
"traits": {
5088-
"smithy.api#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 \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.</p>",
5103+
"smithy.api#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>",
50895104
"smithy.api#examples": [
50905105
{
50915106
"title": "Successful TagResource",
@@ -5198,7 +5213,7 @@
51985213
}
51995214
],
52005215
"traits": {
5201-
"smithy.api#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 \n created during the data ingestion process in the AWS Supply Chain datasets. </p>",
5216+
"smithy.api#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>",
52025217
"smithy.api#examples": [
52035218
{
52045219
"title": "Successful UntagResource",

0 commit comments

Comments
 (0)
Please sign in to comment.