Skip to content

Commit 3e7b610

Browse files
author
awstools
committed
feat(client-connect): SDK release for user defined predefined attributes.
1 parent de42572 commit 3e7b610

23 files changed

+1434
-994
lines changed

‎clients/client-connect/src/commands/CreateContactCommand.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,17 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met
9393
* "<keys>": "<SegmentAttributeValue>",
9494
* },
9595
* ValueInteger: Number("int"),
96+
* ValueList: [ // SegmentAttributeValueList
97+
* "<SegmentAttributeValue>",
98+
* ],
99+
* ValueArn: "STRING_VALUE",
96100
* },
97101
* },
98102
* ValueInteger: Number("int"),
103+
* ValueList: [
104+
* "<SegmentAttributeValue>",
105+
* ],
106+
* ValueArn: "STRING_VALUE",
99107
* },
100108
* },
101109
* PreviousContactId: "STRING_VALUE",

‎clients/client-connect/src/commands/CreatePredefinedAttributeCommand.ts‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,29 @@ export interface CreatePredefinedAttributeCommandInput extends CreatePredefinedA
2828
export interface CreatePredefinedAttributeCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new predefined attribute for the specified Amazon Connect instance. <i>Predefined
32-
* attributes</i> are attributes in an Amazon Connect instance that can be used to route
33-
* contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
34-
* predefined attributes for routing contacts to agents</a>.</p>
31+
* <p>Creates a new predefined attribute for the specified Amazon Connect instance. A <i>predefined
32+
* attribute</i> is made up of a name and a value.</p>
33+
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
34+
* <p>
35+
* <b>Use cases</b>
36+
* </p>
37+
* <p>Following are common uses cases for this API:</p>
38+
* <ul>
39+
* <li>
40+
* <p>Create an attribute for routing proficiency (for example, agent certification) that has
41+
* predefined values (for example, a list of possible certifications). For more information, see
42+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
43+
* predefined attributes for routing contacts to agents</a>.</p>
44+
* </li>
45+
* <li>
46+
* <p>Create an attribute for business unit name that has a list of predefined business unit
47+
* names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see
48+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
49+
* </li>
50+
* </ul>
51+
* <p>
52+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
53+
* quotas</a>.</p>
3554
* @example
3655
* Use a bare-bones client and the command you need to make an API call.
3756
* ```javascript
@@ -46,6 +65,12 @@ export interface CreatePredefinedAttributeCommandOutput extends __MetadataBearer
4665
* "STRING_VALUE",
4766
* ],
4867
* },
68+
* Purposes: [ // PredefinedAttributePurposeNameList
69+
* "STRING_VALUE",
70+
* ],
71+
* AttributeConfiguration: { // InputPredefinedAttributeConfiguration
72+
* EnableValueValidationOnAssociation: true || false,
73+
* },
4974
* };
5075
* const command = new CreatePredefinedAttributeCommand(input);
5176
* const response = await client.send(command);

‎clients/client-connect/src/commands/DeleteIntegrationAssociationCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DeleteIntegrationAssociationRequest } from "../models/models_0";
9+
import { DeleteIntegrationAssociationRequest } from "../models/models_1";
1010
import {
1111
de_DeleteIntegrationAssociationCommand,
1212
se_DeleteIntegrationAssociationCommand,

‎clients/client-connect/src/commands/DescribeContactCommand.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,9 +337,17 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
337337
* // "<keys>": "<SegmentAttributeValue>",
338338
* // },
339339
* // ValueInteger: Number("int"),
340+
* // ValueList: [ // SegmentAttributeValueList
341+
* // "<SegmentAttributeValue>",
342+
* // ],
343+
* // ValueArn: "STRING_VALUE",
340344
* // },
341345
* // },
342346
* // ValueInteger: Number("int"),
347+
* // ValueList: [
348+
* // "<SegmentAttributeValue>",
349+
* // ],
350+
* // ValueArn: "STRING_VALUE",
343351
* // },
344352
* // },
345353
* // Recordings: [ // Recordings

‎clients/client-connect/src/commands/DescribePredefinedAttributeCommand.ts‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,24 @@ export interface DescribePredefinedAttributeCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Describes a predefined attribute for the specified Amazon Connect instance. <i>Predefined
37-
* attributes</i> are attributes in an Amazon Connect instance that can be used to route
38-
* contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
39-
* predefined attributes for routing contacts to agents</a>.</p>
36+
* <p>Describes a predefined attribute for the specified Amazon Connect instance. A <i>predefined
37+
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
38+
* <ul>
39+
* <li>
40+
* <p>Routing proficiency (for example, agent certification) that has
41+
* predefined values (for example, a list of possible certifications). For more information, see
42+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
43+
* predefined attributes for routing contacts to agents</a>.</p>
44+
* </li>
45+
* <li>
46+
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
47+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
48+
* </li>
49+
* </ul>
50+
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
51+
* <p>
52+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
53+
* quotas</a>.</p>
4054
* @example
4155
* Use a bare-bones client and the command you need to make an API call.
4256
* ```javascript
@@ -57,6 +71,13 @@ export interface DescribePredefinedAttributeCommandOutput
5771
* // "STRING_VALUE",
5872
* // ],
5973
* // },
74+
* // Purposes: [ // PredefinedAttributePurposeNameList
75+
* // "STRING_VALUE",
76+
* // ],
77+
* // AttributeConfiguration: { // PredefinedAttributeConfiguration
78+
* // EnableValueValidationOnAssociation: true || false,
79+
* // IsReadOnly: true || false,
80+
* // },
6081
* // LastModifiedTime: new Date("TIMESTAMP"),
6182
* // LastModifiedRegion: "STRING_VALUE",
6283
* // },

‎clients/client-connect/src/commands/ListInstanceStorageConfigsCommand.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { ListInstanceStorageConfigsRequest, ListInstanceStorageConfigsResponse } from "../models/models_1";
9+
import { ListInstanceStorageConfigsRequest } from "../models/models_1";
10+
import { ListInstanceStorageConfigsResponse } from "../models/models_2";
1011
import { de_ListInstanceStorageConfigsCommand, se_ListInstanceStorageConfigsCommand } from "../protocols/Aws_restJson1";
1112

1213
/**

‎clients/client-connect/src/commands/ListIntegrationAssociationsCommand.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { ListIntegrationAssociationsRequest } from "../models/models_1";
10-
import { ListIntegrationAssociationsResponse } from "../models/models_2";
9+
import { ListIntegrationAssociationsRequest, ListIntegrationAssociationsResponse } from "../models/models_2";
1110
import {
1211
de_ListIntegrationAssociationsCommand,
1312
se_ListIntegrationAssociationsCommand,

‎clients/client-connect/src/commands/ListPredefinedAttributesCommand.ts‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,24 @@ export interface ListPredefinedAttributesCommandInput extends ListPredefinedAttr
2828
export interface ListPredefinedAttributesCommandOutput extends ListPredefinedAttributesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists predefined attributes for the specified Amazon Connect instance. <i>Predefined
32-
* attributes</i> are attributes in an Amazon Connect instance that can be used to route
33-
* contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
34-
* predefined attributes for routing contacts to agents</a>.</p>
31+
* <p>Lists predefined attributes for the specified Amazon Connect instance. A <i>predefined
32+
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
33+
* <ul>
34+
* <li>
35+
* <p>Routing proficiency (for example, agent certification) that has
36+
* predefined values (for example, a list of possible certifications). For more information, see
37+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
38+
* predefined attributes for routing contacts to agents</a>.</p>
39+
* </li>
40+
* <li>
41+
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
42+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
43+
* </li>
44+
* </ul>
45+
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
46+
* <p>
47+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
48+
* quotas</a>.</p>
3549
* @example
3650
* Use a bare-bones client and the command you need to make an API call.
3751
* ```javascript

‎clients/client-connect/src/commands/SearchContactsCommand.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {
1010
SearchContactsRequest,
1111
SearchContactsRequestFilterSensitiveLog,
1212
SearchContactsResponse,
13+
SearchContactsResponseFilterSensitiveLog,
1314
} from "../models/models_2";
1415
import { de_SearchContactsCommand, se_SearchContactsCommand } from "../protocols/Aws_restJson1";
1516

@@ -199,7 +200,7 @@ export class SearchContactsCommand extends $Command
199200
})
200201
.s("AmazonConnectService", "SearchContacts", {})
201202
.n("ConnectClient", "SearchContactsCommand")
202-
.f(SearchContactsRequestFilterSensitiveLog, void 0)
203+
.f(SearchContactsRequestFilterSensitiveLog, SearchContactsResponseFilterSensitiveLog)
203204
.ser(se_SearchContactsCommand)
204205
.de(de_SearchContactsCommand)
205206
.build() {

‎clients/client-connect/src/commands/SearchPredefinedAttributesCommand.ts‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,24 @@ export interface SearchPredefinedAttributesCommandInput extends SearchPredefined
2929
export interface SearchPredefinedAttributesCommandOutput extends SearchPredefinedAttributesResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Searches predefined attributes that meet certain criteria. <i>Predefined
33-
* attributes</i> are attributes in an Amazon Connect instance that can be used to route
34-
* contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
35-
* predefined attributes for routing contacts to agents</a>.</p>
32+
* <p>Searches predefined attributes that meet certain criteria. A <i>predefined
33+
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
34+
* <ul>
35+
* <li>
36+
* <p>Routing proficiency (for example, agent certification) that has
37+
* predefined values (for example, a list of possible certifications). For more information, see
38+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
39+
* predefined attributes for routing contacts to agents</a>.</p>
40+
* </li>
41+
* <li>
42+
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
43+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
44+
* </li>
45+
* </ul>
46+
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
47+
* <p>
48+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
49+
* quotas</a>.</p>
3650
* @example
3751
* Use a bare-bones client and the command you need to make an API call.
3852
* ```javascript
@@ -80,6 +94,13 @@ export interface SearchPredefinedAttributesCommandOutput extends SearchPredefine
8094
* // "STRING_VALUE",
8195
* // ],
8296
* // },
97+
* // Purposes: [ // PredefinedAttributePurposeNameList
98+
* // "STRING_VALUE",
99+
* // ],
100+
* // AttributeConfiguration: { // PredefinedAttributeConfiguration
101+
* // EnableValueValidationOnAssociation: true || false,
102+
* // IsReadOnly: true || false,
103+
* // },
83104
* // LastModifiedTime: new Date("TIMESTAMP"),
84105
* // LastModifiedRegion: "STRING_VALUE",
85106
* // },

0 commit comments

Comments
 (0)