Skip to content

Commit 1c86676

Browse files
author
awstools
committed
feat(client-connect): This release supports adding RoutingCriteria via UpdateContactRoutingData public API.
1 parent 61505ca commit 1c86676

20 files changed

+351
-70
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __M
3636
* <p>Initiates an Amazon Connect instance with all the supported channels enabled. It does
3737
* not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It
3838
* also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. </p>
39+
* <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html">Create an Amazon Connect
40+
* instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
3941
* <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days.
4042
* If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances.
4143
* You must wait 30 days before you can restart creating and deleting instances in your account.</p>

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ 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.</p>
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>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

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

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
2929

3030
/**
3131
* <p>Creates a security profile.</p>
32+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
33+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
34+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
35+
* permissions</a>. </p>
3236
* @example
3337
* Use a bare-bones client and the command you need to make an API call.
3438
* ```javascript

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ export interface DeleteInstanceCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
32-
* <p>Deletes the Amazon Connect instance.</p>
32+
* <p>Deletes the Amazon Connect instance. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html">Delete your
33+
* Amazon Connect instance</a> in the <i>Amazon Connect Administrator
34+
* Guide</i>.</p>
3335
* <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days.
3436
* If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances.
3537
* You must wait 30 days before you can restart creating and deleting instances in your account.</p>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteQueueCommandInput extends DeleteQueueRequest {}
2828
export interface DeleteQueueCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a queue.</p>
31+
* <p>Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ export interface DescribePredefinedAttributeCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Describes a predefined attribute for the specified Amazon Connect instance.</p>
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>
3740
* @example
3841
* Use a bare-bones client and the command you need to make an API call.
3942
* ```javascript

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

+5-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ export interface DescribeSecurityProfileCommandInput extends DescribeSecurityPro
2828
export interface DescribeSecurityProfileCommandOutput extends DescribeSecurityProfileResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets basic information about the security profle.</p>
31+
* <p>Gets basic information about the security profile.</p>
32+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
33+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
34+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
35+
* permissions</a>. </p>
3236
* @example
3337
* Use a bare-bones client and the command you need to make an API call.
3438
* ```javascript

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ 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.</p>
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>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

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

+4
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ export interface ListSecurityProfilePermissionsCommandOutput
3434

3535
/**
3636
* <p>Lists the permissions granted to a security profile.</p>
37+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
38+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
39+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
40+
* permissions</a>. </p>
3741
* @example
3842
* Use a bare-bones client and the command you need to make an API call.
3943
* ```javascript

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR
3030
/**
3131
* <p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p>
3232
* <p>For more information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
33-
* <i>Amazon Connect Administrator Guide</i>.</p>
33+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
34+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
35+
* permissions</a>. </p>
3436
* @example
3537
* Use a bare-bones client and the command you need to make an API call.
3638
* ```javascript

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface SearchPredefinedAttributesCommandInput extends SearchPredefined
2828
export interface SearchPredefinedAttributesCommandOutput extends SearchPredefinedAttributesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Predefined attributes that meet certain criteria.</p>
31+
* <p>Searches predefined attributes that meet certain criteria. <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>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

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

+4
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ export interface SearchSecurityProfilesCommandOutput extends SearchSecurityProfi
3030
/**
3131
* <p>Searches security profiles in an Amazon Connect instance, with optional
3232
* filtering.</p>
33+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
34+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
35+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
36+
* permissions</a>. </p>
3337
* @example
3438
* Use a bare-bones client and the command you need to make an API call.
3539
* ```javascript

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

+50
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,56 @@ export interface UpdateContactRoutingDataCommandOutput extends UpdateContactRout
5252
* ContactId: "STRING_VALUE", // required
5353
* QueueTimeAdjustmentSeconds: Number("int"),
5454
* QueuePriority: Number("long"),
55+
* RoutingCriteria: { // RoutingCriteriaInput
56+
* Steps: [ // RoutingCriteriaInputSteps
57+
* { // RoutingCriteriaInputStep
58+
* Expiry: { // RoutingCriteriaInputStepExpiry
59+
* DurationInSeconds: Number("int"),
60+
* },
61+
* Expression: { // Expression
62+
* AttributeCondition: { // AttributeCondition
63+
* Name: "STRING_VALUE",
64+
* Value: "STRING_VALUE",
65+
* ProficiencyLevel: Number("float"),
66+
* MatchCriteria: { // MatchCriteria
67+
* AgentsCriteria: { // AgentsCriteria
68+
* AgentIds: [ // AgentIds
69+
* "STRING_VALUE",
70+
* ],
71+
* },
72+
* },
73+
* ComparisonOperator: "STRING_VALUE",
74+
* },
75+
* AndExpression: [ // Expressions
76+
* {
77+
* AttributeCondition: {
78+
* Name: "STRING_VALUE",
79+
* Value: "STRING_VALUE",
80+
* ProficiencyLevel: Number("float"),
81+
* MatchCriteria: {
82+
* AgentsCriteria: {
83+
* AgentIds: [
84+
* "STRING_VALUE",
85+
* ],
86+
* },
87+
* },
88+
* ComparisonOperator: "STRING_VALUE",
89+
* },
90+
* AndExpression: [
91+
* "<Expression>",
92+
* ],
93+
* OrExpression: [
94+
* "<Expression>",
95+
* ],
96+
* },
97+
* ],
98+
* OrExpression: [
99+
* "<Expression>",
100+
* ],
101+
* },
102+
* },
103+
* ],
104+
* },
55105
* };
56106
* const command = new UpdateContactRoutingDataCommand(input);
57107
* const response = await client.send(command);

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface UpdatePredefinedAttributeCommandInput extends UpdatePredefinedA
2828
export interface UpdatePredefinedAttributeCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates a predefined attribute for the specified Amazon Connect instance.</p>
31+
* <p>Updates a 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>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

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

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ export interface UpdateSecurityProfileCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Updates a security profile.</p>
32+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
33+
* <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
34+
* user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
35+
* permissions</a>. </p>
3236
* @example
3337
* Use a bare-bones client and the command you need to make an API call.
3438
* ```javascript

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -615,14 +615,14 @@ export interface AgentQualityMetrics {
615615
}
616616

617617
/**
618-
* <p>Can be used to define a list of preferred agents to target the contact within the queue.
618+
* <p>Can be used to define a list of preferred agents to target the contact to within the queue.
619619
* Note that agents must have the queue in their routing profile in order to be offered the
620620
* contact.</p>
621621
* @public
622622
*/
623623
export interface AgentsCriteria {
624624
/**
625-
* <p>An object to specify a list of agents, by Agent ID.</p>
625+
* <p>An object to specify a list of agents, by user ID.</p>
626626
* @public
627627
*/
628628
AgentIds?: string[];
@@ -7056,12 +7056,12 @@ export interface Expiry {
70567056
}
70577057

70587058
/**
7059-
* <p>An object to define <code>AgentsCriteria</code>.</p>
7059+
* <p>An object to define AgentsCriteria.</p>
70607060
* @public
70617061
*/
70627062
export interface MatchCriteria {
70637063
/**
7064-
* <p>An object to define <code>AgentIds</code>.</p>
7064+
* <p>An object to define agentIds.</p>
70657065
* @public
70667066
*/
70677067
AgentsCriteria?: AgentsCriteria;

‎clients/client-connect/src/models/models_1.ts

+9-13
Original file line numberDiff line numberDiff line change
@@ -8869,31 +8869,27 @@ export interface RealTimeContactAnalysisSegmentPostContactSummary {
88698869
Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
88708870

88718871
/**
8872-
* <p>If the summary failed to be generated, one of the following failure codes
8873-
* occurs:</p>
8872+
* <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
88748873
* <ul>
88758874
* <li>
88768875
* <p>
8877-
* <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached
8878-
* your service quota.</p>
8876+
* <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
8877+
* quota.</p>
88798878
* </li>
88808879
* <li>
88818880
* <p>
8882-
* <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have
8883-
* at least one turn from both the participants in order to generate the
8884-
* summary.</p>
8881+
* <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
8882+
* one turn from both the participants in order to generate the summary.</p>
88858883
* </li>
88868884
* <li>
88878885
* <p>
8888-
* <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be
8889-
* provided because it failed to meet system safety guidelines.</p>
8886+
* <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
8887+
* failed to meet system safety guidelines.</p>
88908888
* </li>
88918889
* <li>
88928890
* <p>
8893-
* <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for
8894-
* example, you're using a
8895-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a>
8896-
* that isn't supported by generative AI-powered post-contact summaries.
8891+
* <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
8892+
* using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
88978893
* </p>
88988894
* </li>
88998895
* <li>

0 commit comments

Comments
 (0)