Skip to content

Commit a6fb5eb

Browse files
author
awstools
committed
feat(client-customer-profiles): Added isUnstructured in response for Customer Profiles Integration APIs
1 parent 098e850 commit a6fb5eb

File tree

9 files changed

+68
-13
lines changed

9 files changed

+68
-13
lines changed

clients/client-customer-profiles/src/CustomerProfiles.ts

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ import { CustomerProfilesClient } from "./CustomerProfilesClient";
187187
*/
188188
export class CustomerProfiles extends CustomerProfilesClient {
189189
/**
190-
* <p>Associates a new key value with a specific profile, such as a Contact Trace Record (CTR)
190+
* <p>Associates a new key value with a specific profile, such as a Contact Record
191191
* ContactId.</p>
192192
* <p>A profile object can have a single unique key and any number of additional keys that can
193193
* be used to identify the profile that it belongs to.</p>
@@ -1249,6 +1249,9 @@ export class CustomerProfiles extends CustomerProfilesClient {
12491249
* <p>Adds an integration between the service and a third-party service, which includes
12501250
* Amazon AppFlow and Amazon Connect.</p>
12511251
* <p>An integration can belong to only one domain.</p>
1252+
* <p>To add or remove tags on an existing Integration, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource
1253+
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
1254+
* UntagResource</a>.</p>
12521255
*/
12531256
public putIntegration(
12541257
args: PutIntegrationCommandInput,
@@ -1281,9 +1284,9 @@ export class CustomerProfiles extends CustomerProfilesClient {
12811284

12821285
/**
12831286
* <p>Adds additional objects to customer profiles of a given ObjectType.</p>
1284-
* <p>When adding a specific profile object, like a Contact Trace Record (CTR), an inferred
1285-
* profile can get created if it is not mapped to an existing profile. The resulting profile
1286-
* will only have a phone number populated in the standard ProfileObject. Any additional CTRs
1287+
* <p>When adding a specific profile object, like a Contact Record, an inferred profile can
1288+
* get created if it is not mapped to an existing profile. The resulting profile will only
1289+
* have a phone number populated in the standard ProfileObject. Any additional Contact Records
12871290
* with the same phone number will be mapped to the same inferred profile.</p>
12881291
* <p>When a ProfileObject is created and if a ProfileObjectType already exists for the
12891292
* ProfileObject, it will provide data to a standard profile depending on the
@@ -1322,6 +1325,8 @@ export class CustomerProfiles extends CustomerProfilesClient {
13221325

13231326
/**
13241327
* <p>Defines a ProfileObjectType.</p>
1328+
* <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
1329+
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
13251330
*/
13261331
public putProfileObjectType(
13271332
args: PutProfileObjectTypeCommandInput,
@@ -1464,6 +1469,7 @@ export class CustomerProfiles extends CustomerProfilesClient {
14641469
* resolution</a>: set <code>Matching</code> to true. </p>
14651470
* <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
14661471
* apply. </p>
1472+
* <p>To add or remove tags on an existing Domain, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
14671473
*/
14681474
public updateDomain(
14691475
args: UpdateDomainCommandInput,

clients/client-customer-profiles/src/commands/AddProfileKeyCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface AddProfileKeyCommandInput extends AddProfileKeyRequest {}
2828
export interface AddProfileKeyCommandOutput extends AddProfileKeyResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Associates a new key value with a specific profile, such as a Contact Trace Record (CTR)
31+
* <p>Associates a new key value with a specific profile, such as a Contact Record
3232
* ContactId.</p>
3333
* <p>A profile object can have a single unique key and any number of additional keys that can
3434
* be used to identify the profile that it belongs to.</p>

clients/client-customer-profiles/src/commands/PutIntegrationCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M
3131
* <p>Adds an integration between the service and a third-party service, which includes
3232
* Amazon AppFlow and Amazon Connect.</p>
3333
* <p>An integration can belong to only one domain.</p>
34+
* <p>To add or remove tags on an existing Integration, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource
35+
* </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">
36+
* UntagResource</a>.</p>
3437
* @example
3538
* Use a bare-bones client and the command you need to make an API call.
3639
* ```javascript

clients/client-customer-profiles/src/commands/PutProfileObjectCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface PutProfileObjectCommandOutput extends PutProfileObjectResponse,
2929

3030
/**
3131
* <p>Adds additional objects to customer profiles of a given ObjectType.</p>
32-
* <p>When adding a specific profile object, like a Contact Trace Record (CTR), an inferred
33-
* profile can get created if it is not mapped to an existing profile. The resulting profile
34-
* will only have a phone number populated in the standard ProfileObject. Any additional CTRs
32+
* <p>When adding a specific profile object, like a Contact Record, an inferred profile can
33+
* get created if it is not mapped to an existing profile. The resulting profile will only
34+
* have a phone number populated in the standard ProfileObject. Any additional Contact Records
3535
* with the same phone number will be mapped to the same inferred profile.</p>
3636
* <p>When a ProfileObject is created and if a ProfileObjectType already exists for the
3737
* ProfileObject, it will provide data to a standard profile depending on the

clients/client-customer-profiles/src/commands/PutProfileObjectTypeCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR
2929

3030
/**
3131
* <p>Defines a ProfileObjectType.</p>
32+
* <p>To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">
33+
* TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript

clients/client-customer-profiles/src/commands/UpdateDomainCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
3636
* resolution</a>: set <code>Matching</code> to true. </p>
3737
* <p>To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should
3838
* apply. </p>
39+
* <p>To add or remove tags on an existing Domain, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
3940
* @example
4041
* Use a bare-bones client and the command you need to make an API call.
4142
* ```javascript

clients/client-customer-profiles/src/models/models_0.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1758,6 +1758,12 @@ export interface GetIntegrationResponse {
17581758
* <p>Unique identifier for the workflow.</p>
17591759
*/
17601760
WorkflowId?: string;
1761+
1762+
/**
1763+
* <p>Boolean to indicate if the Flow associated with the Integration is created via Appflow
1764+
* console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>
1765+
*/
1766+
IsUnstructured?: boolean;
17611767
}
17621768

17631769
export interface GetMatchesRequest {
@@ -2215,6 +2221,12 @@ export interface ListIntegrationItem {
22152221
* <p>Unique identifier for the workflow.</p>
22162222
*/
22172223
WorkflowId?: string;
2224+
2225+
/**
2226+
* <p>Boolean to indicate if the Flow associated with the Integration is created via Appflow
2227+
* console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>
2228+
*/
2229+
IsUnstructured?: boolean;
22182230
}
22192231

22202232
export interface ListAccountIntegrationsResponse {
@@ -2928,6 +2940,12 @@ export interface PutIntegrationResponse {
29282940
* <p>Unique identifier for the workflow.</p>
29292941
*/
29302942
WorkflowId?: string;
2943+
2944+
/**
2945+
* <p>Boolean to indicate if the Flow associated with the Integration is created via Appflow
2946+
* console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>
2947+
*/
2948+
IsUnstructured?: boolean;
29312949
}
29322950

29332951
export interface PutProfileObjectRequest {

clients/client-customer-profiles/src/protocols/Aws_restJson1.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2112,6 +2112,9 @@ export const deserializeAws_restJson1GetIntegrationCommand = async (
21122112
if (data.DomainName != null) {
21132113
contents.DomainName = __expectString(data.DomainName);
21142114
}
2115+
if (data.IsUnstructured != null) {
2116+
contents.IsUnstructured = __expectBoolean(data.IsUnstructured);
2117+
}
21152118
if (data.LastUpdatedAt != null) {
21162119
contents.LastUpdatedAt = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.LastUpdatedAt)));
21172120
}
@@ -3089,6 +3092,9 @@ export const deserializeAws_restJson1PutIntegrationCommand = async (
30893092
if (data.DomainName != null) {
30903093
contents.DomainName = __expectString(data.DomainName);
30913094
}
3095+
if (data.IsUnstructured != null) {
3096+
contents.IsUnstructured = __expectBoolean(data.IsUnstructured);
3097+
}
30923098
if (data.LastUpdatedAt != null) {
30933099
contents.LastUpdatedAt = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.LastUpdatedAt)));
30943100
}
@@ -4396,6 +4402,7 @@ const deserializeAws_restJson1ListIntegrationItem = (output: any, context: __Ser
43964402
CreatedAt:
43974403
output.CreatedAt != null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreatedAt))) : undefined,
43984404
DomainName: __expectString(output.DomainName),
4405+
IsUnstructured: __expectBoolean(output.IsUnstructured),
43994406
LastUpdatedAt:
44004407
output.LastUpdatedAt != null
44014408
? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LastUpdatedAt)))

codegen/sdk-codegen/aws-models/customer-profiles.json

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
}
6969
],
7070
"traits": {
71-
"smithy.api#documentation": "<p>Associates a new key value with a specific profile, such as a Contact Trace Record (CTR)\n ContactId.</p>\n <p>A profile object can have a single unique key and any number of additional keys that can\n be used to identify the profile that it belongs to.</p>",
71+
"smithy.api#documentation": "<p>Associates a new key value with a specific profile, such as a Contact Record\n ContactId.</p>\n <p>A profile object can have a single unique key and any number of additional keys that can\n be used to identify the profile that it belongs to.</p>",
7272
"smithy.api#http": {
7373
"method": "POST",
7474
"uri": "/domains/{DomainName}/profiles/keys",
@@ -2400,6 +2400,12 @@
24002400
"traits": {
24012401
"smithy.api#documentation": "<p>Unique identifier for the workflow.</p>"
24022402
}
2403+
},
2404+
"IsUnstructured": {
2405+
"target": "com.amazonaws.customerprofiles#optionalBoolean",
2406+
"traits": {
2407+
"smithy.api#documentation": "<p>Boolean to indicate if the Flow associated with the Integration is created via Appflow \n console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>"
2408+
}
24032409
}
24042410
}
24052411
},
@@ -3504,6 +3510,12 @@
35043510
"traits": {
35053511
"smithy.api#documentation": "<p>Unique identifier for the workflow.</p>"
35063512
}
3513+
},
3514+
"IsUnstructured": {
3515+
"target": "com.amazonaws.customerprofiles#optionalBoolean",
3516+
"traits": {
3517+
"smithy.api#documentation": "<p>Boolean to indicate if the Flow associated with the Integration is created via Appflow\n console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>"
3518+
}
35073519
}
35083520
},
35093521
"traits": {
@@ -4812,7 +4824,7 @@
48124824
}
48134825
],
48144826
"traits": {
4815-
"smithy.api#documentation": "<p>Adds an integration between the service and a third-party service, which includes\n Amazon AppFlow and Amazon Connect.</p>\n <p>An integration can belong to only one domain.</p>",
4827+
"smithy.api#documentation": "<p>Adds an integration between the service and a third-party service, which includes\n Amazon AppFlow and Amazon Connect.</p>\n <p>An integration can belong to only one domain.</p>\n <p>To add or remove tags on an existing Integration, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\"> TagResource\n </a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">\n UntagResource</a>.</p>",
48164828
"smithy.api#http": {
48174829
"method": "PUT",
48184830
"uri": "/domains/{DomainName}/integrations",
@@ -4917,6 +4929,12 @@
49174929
"traits": {
49184930
"smithy.api#documentation": "<p>Unique identifier for the workflow.</p>"
49194931
}
4932+
},
4933+
"IsUnstructured": {
4934+
"target": "com.amazonaws.customerprofiles#optionalBoolean",
4935+
"traits": {
4936+
"smithy.api#documentation": "<p>Boolean to indicate if the Flow associated with the Integration is created via Appflow \n console or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition</p>"
4937+
}
49204938
}
49214939
}
49224940
},
@@ -4946,7 +4964,7 @@
49464964
}
49474965
],
49484966
"traits": {
4949-
"smithy.api#documentation": "<p>Adds additional objects to customer profiles of a given ObjectType.</p>\n <p>When adding a specific profile object, like a Contact Trace Record (CTR), an inferred\n profile can get created if it is not mapped to an existing profile. The resulting profile\n will only have a phone number populated in the standard ProfileObject. Any additional CTRs\n with the same phone number will be mapped to the same inferred profile.</p>\n <p>When a ProfileObject is created and if a ProfileObjectType already exists for the\n ProfileObject, it will provide data to a standard profile depending on the\n ProfileObjectType definition.</p>\n <p>PutProfileObject needs an ObjectType, which can be created using\n PutProfileObjectType.</p>",
4967+
"smithy.api#documentation": "<p>Adds additional objects to customer profiles of a given ObjectType.</p>\n <p>When adding a specific profile object, like a Contact Record, an inferred profile can\n get created if it is not mapped to an existing profile. The resulting profile will only\n have a phone number populated in the standard ProfileObject. Any additional Contact Records\n with the same phone number will be mapped to the same inferred profile.</p>\n <p>When a ProfileObject is created and if a ProfileObjectType already exists for the\n ProfileObject, it will provide data to a standard profile depending on the\n ProfileObjectType definition.</p>\n <p>PutProfileObject needs an ObjectType, which can be created using\n PutProfileObjectType.</p>",
49504968
"smithy.api#http": {
49514969
"method": "PUT",
49524970
"uri": "/domains/{DomainName}/profiles/objects",
@@ -5018,7 +5036,7 @@
50185036
}
50195037
],
50205038
"traits": {
5021-
"smithy.api#documentation": "<p>Defines a ProfileObjectType.</p>",
5039+
"smithy.api#documentation": "<p>Defines a ProfileObjectType.</p>\n <p>To add or remove tags on an existing ObjectType, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\">\n TagResource</a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">UntagResource</a>.</p>",
50225040
"smithy.api#http": {
50235041
"method": "PUT",
50245042
"uri": "/domains/{DomainName}/object-types/{ObjectTypeName}",
@@ -6356,7 +6374,7 @@
63566374
}
63576375
],
63586376
"traits": {
6359-
"smithy.api#documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.</p>\n <p>After a domain is created, the name can’t be changed.</p>\n <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> to\n enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity\n resolution</a>: set <code>Matching</code> to true. </p>\n <p>To prevent cross-service impersonation when you call this API, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html\">Cross-service confused deputy prevention</a> for sample policies that you should\n apply. </p>",
6377+
"smithy.api#documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.</p>\n <p>After a domain is created, the name can’t be changed.</p>\n <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> to\n enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity\n resolution</a>: set <code>Matching</code> to true. </p>\n <p>To prevent cross-service impersonation when you call this API, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html\">Cross-service confused deputy prevention</a> for sample policies that you should\n apply. </p>\n <p>To add or remove tags on an existing Domain, see <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html\">TagResource</a>/<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html\">UntagResource</a>.</p>",
63606378
"smithy.api#http": {
63616379
"method": "PUT",
63626380
"uri": "/domains/{DomainName}",

0 commit comments

Comments
 (0)