Skip to content

Commit 1ee37d6

Browse files
author
AWS
committed
Amazon Connect Service Update: This release adds APIs to provision agents that are global / available in multiple AWS regions and distribute them across these regions by percentage.
1 parent 50f81fb commit 1ee37d6

File tree

3 files changed

+256
-5
lines changed

3 files changed

+256
-5
lines changed

‎.changes/next-release/feature-AmazonConnectService-0d38a76.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": "Amazon Connect Service",
4+
"contributor": "",
5+
"description": "This release adds APIs to provision agents that are global / available in multiple AWS regions and distribute them across these regions by percentage."
6+
}

‎services/connect/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,12 @@
198198
"output_token": "NextToken",
199199
"result_key": "TaskTemplates"
200200
},
201+
"ListTrafficDistributionGroupUsers": {
202+
"input_token": "NextToken",
203+
"limit_key": "MaxResults",
204+
"output_token": "NextToken",
205+
"result_key": "TrafficDistributionGroupUserSummaryList"
206+
},
201207
"ListTrafficDistributionGroups": {
202208
"input_token": "NextToken",
203209
"limit_key": "MaxResults",

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

Lines changed: 244 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,25 @@
205205
],
206206
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Associates a security key to the instance.</p>"
207207
},
208+
"AssociateTrafficDistributionGroupUser":{
209+
"name":"AssociateTrafficDistributionGroupUser",
210+
"http":{
211+
"method":"PUT",
212+
"requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user"
213+
},
214+
"input":{"shape":"AssociateTrafficDistributionGroupUserRequest"},
215+
"output":{"shape":"AssociateTrafficDistributionGroupUserResponse"},
216+
"errors":[
217+
{"shape":"InvalidRequestException"},
218+
{"shape":"AccessDeniedException"},
219+
{"shape":"ThrottlingException"},
220+
{"shape":"ResourceNotFoundException"},
221+
{"shape":"ResourceConflictException"},
222+
{"shape":"InternalServiceException"}
223+
],
224+
"documentation":"<p>Associates an agent with a traffic distribution group.</p>",
225+
"idempotent":true
226+
},
208227
"ClaimPhoneNumber":{
209228
"name":"ClaimPhoneNumber",
210229
"http":{
@@ -1445,6 +1464,25 @@
14451464
],
14461465
"documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the specified security key.</p>"
14471466
},
1467+
"DisassociateTrafficDistributionGroupUser":{
1468+
"name":"DisassociateTrafficDistributionGroupUser",
1469+
"http":{
1470+
"method":"DELETE",
1471+
"requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user"
1472+
},
1473+
"input":{"shape":"DisassociateTrafficDistributionGroupUserRequest"},
1474+
"output":{"shape":"DisassociateTrafficDistributionGroupUserResponse"},
1475+
"errors":[
1476+
{"shape":"InvalidRequestException"},
1477+
{"shape":"AccessDeniedException"},
1478+
{"shape":"ThrottlingException"},
1479+
{"shape":"ResourceNotFoundException"},
1480+
{"shape":"ResourceConflictException"},
1481+
{"shape":"InternalServiceException"}
1482+
],
1483+
"documentation":"<p>Disassociates an agent from a traffic distribution group.</p>",
1484+
"idempotent":true
1485+
},
14481486
"DismissUserContact":{
14491487
"name":"DismissUserContact",
14501488
"http":{
@@ -1928,7 +1966,7 @@
19281966
{"shape":"InternalServiceException"},
19291967
{"shape":"AccessDeniedException"}
19301968
],
1931-
"documentation":"<p>Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided <code>TargetArn</code> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.</p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
1969+
"documentation":"<p>Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided <code>TargetArn</code> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.</p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <ul> <li> <p>When given an instance ARN, <code>ListPhoneNumbersV2</code> returns only the phone numbers claimed to the instance.</p> </li> <li> <p>When given a traffic distribution group ARN <code>ListPhoneNumbersV2</code> returns only the phone numbers claimed to the traffic distribution group.</p> </li> </ul> </note>"
19321970
},
19331971
"ListPrompts":{
19341972
"name":"ListPrompts",
@@ -2134,6 +2172,23 @@
21342172
],
21352173
"documentation":"<p>Lists task templates for the specified Amazon Connect instance.</p>"
21362174
},
2175+
"ListTrafficDistributionGroupUsers":{
2176+
"name":"ListTrafficDistributionGroupUsers",
2177+
"http":{
2178+
"method":"GET",
2179+
"requestUri":"/traffic-distribution-group/{TrafficDistributionGroupId}/user"
2180+
},
2181+
"input":{"shape":"ListTrafficDistributionGroupUsersRequest"},
2182+
"output":{"shape":"ListTrafficDistributionGroupUsersResponse"},
2183+
"errors":[
2184+
{"shape":"ResourceNotFoundException"},
2185+
{"shape":"InvalidRequestException"},
2186+
{"shape":"AccessDeniedException"},
2187+
{"shape":"ThrottlingException"},
2188+
{"shape":"InternalServiceException"}
2189+
],
2190+
"documentation":"<p>Lists traffic distribution group users.</p>"
2191+
},
21372192
"ListTrafficDistributionGroups":{
21382193
"name":"ListTrafficDistributionGroups",
21392194
"http":{
@@ -3256,7 +3311,7 @@
32563311
{"shape":"ThrottlingException"},
32573312
{"shape":"InternalServiceException"}
32583313
],
3259-
"documentation":"<p>Updates the traffic distribution for a given traffic distribution group. </p> <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </p>"
3314+
"documentation":"<p>Updates the traffic distribution for a given traffic distribution group. </p> <note> <p>You can change the <code>SignInConfig</code> only for a default <code>TrafficDistributionGroup</code>. If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note> <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </p>"
32603315
},
32613316
"UpdateUserHierarchy":{
32623317
"name":"UpdateUserHierarchy",
@@ -3467,6 +3522,17 @@
34673522
"TIME_SINCE_LAST_INBOUND"
34683523
]
34693524
},
3525+
"AgentConfig":{
3526+
"type":"structure",
3527+
"required":["Distributions"],
3528+
"members":{
3529+
"Distributions":{
3530+
"shape":"DistributionList",
3531+
"documentation":"<p>Information about traffic distributions.</p>"
3532+
}
3533+
},
3534+
"documentation":"<p>The distribution of agents between the instance and its replica(s).</p>"
3535+
},
34703536
"AgentContactReference":{
34713537
"type":"structure",
34723538
"members":{
@@ -3938,6 +4004,35 @@
39384004
}
39394005
}
39404006
},
4007+
"AssociateTrafficDistributionGroupUserRequest":{
4008+
"type":"structure",
4009+
"required":[
4010+
"TrafficDistributionGroupId",
4011+
"UserId",
4012+
"InstanceId"
4013+
],
4014+
"members":{
4015+
"TrafficDistributionGroupId":{
4016+
"shape":"TrafficDistributionGroupIdOrArn",
4017+
"documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>",
4018+
"location":"uri",
4019+
"locationName":"TrafficDistributionGroupId"
4020+
},
4021+
"UserId":{
4022+
"shape":"UserId",
4023+
"documentation":"<p>The identifier of the user account. This can be the ID or the ARN of the user. </p>"
4024+
},
4025+
"InstanceId":{
4026+
"shape":"InstanceId",
4027+
"documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"
4028+
}
4029+
}
4030+
},
4031+
"AssociateTrafficDistributionGroupUserResponse":{
4032+
"type":"structure",
4033+
"members":{
4034+
}
4035+
},
39414036
"AssociationId":{
39424037
"type":"string",
39434038
"max":100,
@@ -5185,7 +5280,7 @@
51855280
},
51865281
"AgentAvailabilityTimer":{
51875282
"shape":"AgentAvailabilityTimer",
5188-
"documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </p>"
5283+
"documentation":"<p>Whether agents with this routing profile will have their routing order calculated based on <i>longest idle time</i> or <i>time since their last inbound contact</i>. </p>"
51895284
}
51905285
}
51915286
},
@@ -7223,6 +7318,39 @@
72237318
}
72247319
}
72257320
},
7321+
"DisassociateTrafficDistributionGroupUserRequest":{
7322+
"type":"structure",
7323+
"required":[
7324+
"TrafficDistributionGroupId",
7325+
"UserId",
7326+
"InstanceId"
7327+
],
7328+
"members":{
7329+
"TrafficDistributionGroupId":{
7330+
"shape":"TrafficDistributionGroupIdOrArn",
7331+
"documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>",
7332+
"location":"uri",
7333+
"locationName":"TrafficDistributionGroupId"
7334+
},
7335+
"UserId":{
7336+
"shape":"UserId",
7337+
"documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>",
7338+
"location":"querystring",
7339+
"locationName":"UserId"
7340+
},
7341+
"InstanceId":{
7342+
"shape":"InstanceId",
7343+
"documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>",
7344+
"location":"querystring",
7345+
"locationName":"InstanceId"
7346+
}
7347+
}
7348+
},
7349+
"DisassociateTrafficDistributionGroupUserResponse":{
7350+
"type":"structure",
7351+
"members":{
7352+
}
7353+
},
72267354
"DismissUserContactRequest":{
72277355
"type":"structure",
72287356
"required":[
@@ -8420,7 +8548,7 @@
84208548
},
84218549
"UserId":{
84228550
"shape":"AgentResourceId",
8423-
"documentation":"<p>The identifier for the user.</p>"
8551+
"documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>"
84248552
}
84258553
}
84268554
},
@@ -8687,6 +8815,14 @@
86878815
"Arn":{
86888816
"shape":"TrafficDistributionGroupArn",
86898817
"documentation":"<p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>"
8818+
},
8819+
"SignInConfig":{
8820+
"shape":"SignInConfig",
8821+
"documentation":"<p>The distribution of allowing signing in to the instance and its replica(s).</p>"
8822+
},
8823+
"AgentConfig":{
8824+
"shape":"AgentConfig",
8825+
"documentation":"<p>The distribution of agents between the instance and its replica(s).</p>"
86908826
}
86918827
}
86928828
},
@@ -10998,6 +11134,44 @@
1099811134
}
1099911135
}
1100011136
},
11137+
"ListTrafficDistributionGroupUsersRequest":{
11138+
"type":"structure",
11139+
"required":["TrafficDistributionGroupId"],
11140+
"members":{
11141+
"TrafficDistributionGroupId":{
11142+
"shape":"TrafficDistributionGroupIdOrArn",
11143+
"documentation":"<p>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</p>",
11144+
"location":"uri",
11145+
"locationName":"TrafficDistributionGroupId"
11146+
},
11147+
"MaxResults":{
11148+
"shape":"MaxResult10",
11149+
"documentation":"<p>The maximum number of results to return per page.</p>",
11150+
"box":true,
11151+
"location":"querystring",
11152+
"locationName":"maxResults"
11153+
},
11154+
"NextToken":{
11155+
"shape":"NextToken",
11156+
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
11157+
"location":"querystring",
11158+
"locationName":"nextToken"
11159+
}
11160+
}
11161+
},
11162+
"ListTrafficDistributionGroupUsersResponse":{
11163+
"type":"structure",
11164+
"members":{
11165+
"NextToken":{
11166+
"shape":"NextToken",
11167+
"documentation":"<p>If there are additional results, this is the token for the next set of results.</p>"
11168+
},
11169+
"TrafficDistributionGroupUserSummaryList":{
11170+
"shape":"TrafficDistributionGroupUserSummaryList",
11171+
"documentation":"<p>A list of traffic distribution group users.</p>"
11172+
}
11173+
}
11174+
},
1100111175
"ListTrafficDistributionGroupsRequest":{
1100211176
"type":"structure",
1100311177
"members":{
@@ -13932,6 +14106,39 @@
1393214106
"error":{"httpStatusCode":402},
1393314107
"exception":true
1393414108
},
14109+
"SignInConfig":{
14110+
"type":"structure",
14111+
"required":["Distributions"],
14112+
"members":{
14113+
"Distributions":{
14114+
"shape":"SignInDistributionList",
14115+
"documentation":"<p>Information about traffic distributions.</p>"
14116+
}
14117+
},
14118+
"documentation":"<p>The distribution of allowing signing in to the instance and its replica(s).</p>"
14119+
},
14120+
"SignInDistribution":{
14121+
"type":"structure",
14122+
"required":[
14123+
"Region",
14124+
"Enabled"
14125+
],
14126+
"members":{
14127+
"Region":{
14128+
"shape":"AwsRegion",
14129+
"documentation":"<p>The Amazon Web Services Region of the sign in distribution.</p>"
14130+
},
14131+
"Enabled":{
14132+
"shape":"Boolean",
14133+
"documentation":"<p>Whether sign in distribution is enabled.</p>"
14134+
}
14135+
},
14136+
"documentation":"<p>The distribution of sign in traffic between the instance and its replica(s).</p>"
14137+
},
14138+
"SignInDistributionList":{
14139+
"type":"list",
14140+
"member":{"shape":"SignInDistribution"}
14141+
},
1393514142
"SingleSelectOptions":{
1393614143
"type":"list",
1393714144
"member":{"shape":"TaskTemplateSingleSelectOption"}
@@ -14971,6 +15178,10 @@
1497115178
"Tags":{
1497215179
"shape":"TagMap",
1497315180
"documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>"
15181+
},
15182+
"IsDefault":{
15183+
"shape":"Boolean",
15184+
"documentation":"<p>Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as part of the process for deleting a replica.</p> <note> <p>You can change the <code>SignInConfig</code> only for a default <code>TrafficDistributionGroup</code>. If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note>"
1497415185
}
1497515186
},
1497615187
"documentation":"<p>Information about a traffic distribution group.</p>"
@@ -15020,6 +15231,10 @@
1502015231
"Status":{
1502115232
"shape":"TrafficDistributionGroupStatus",
1502215233
"documentation":"<p>The status of the traffic distribution group. </p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>ACTIVE</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has succeeded.</p> </li> <li> <p> <code>CREATION_FAILED</code> indicates that the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html\">CreateTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>PENDING_DELETION</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> <li> <p> <code>DELETION_FAILED</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html\">DeleteTrafficDistributionGroup</a> operation has failed.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> means the previous <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html\">UpdateTrafficDistributionGroup</a> operation is still in progress and has not yet completed.</p> </li> </ul>"
15234+
},
15235+
"IsDefault":{
15236+
"shape":"Boolean",
15237+
"documentation":"<p>Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as part of the process for deleting a replica.</p>"
1502315238
}
1502415239
},
1502515240
"documentation":"<p>Information about traffic distribution groups.</p>"
@@ -15030,6 +15245,22 @@
1503015245
"max":10,
1503115246
"min":0
1503215247
},
15248+
"TrafficDistributionGroupUserSummary":{
15249+
"type":"structure",
15250+
"members":{
15251+
"UserId":{
15252+
"shape":"UserId",
15253+
"documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>"
15254+
}
15255+
},
15256+
"documentation":"<p>Summary information about a traffic distribution group user.</p>"
15257+
},
15258+
"TrafficDistributionGroupUserSummaryList":{
15259+
"type":"list",
15260+
"member":{"shape":"TrafficDistributionGroupUserSummary"},
15261+
"max":10,
15262+
"min":0
15263+
},
1503315264
"TrafficType":{
1503415265
"type":"string",
1503515266
"enum":[
@@ -15059,7 +15290,7 @@
1505915290
},
1506015291
"UserId":{
1506115292
"shape":"AgentResourceId",
15062-
"documentation":"<p>The identifier for the user.</p>"
15293+
"documentation":"<p>The identifier for the user. This can be the ID or the ARN of the user.</p>"
1506315294
},
1506415295
"ContactFlowId":{
1506515296
"shape":"ContactFlowId",
@@ -16293,6 +16524,14 @@
1629316524
"TelephonyConfig":{
1629416525
"shape":"TelephonyConfig",
1629516526
"documentation":"<p>The distribution of traffic between the instance and its replica(s).</p>"
16527+
},
16528+
"SignInConfig":{
16529+
"shape":"SignInConfig",
16530+
"documentation":"<p>The distribution of allowing signing in to the instance and its replica(s).</p>"
16531+
},
16532+
"AgentConfig":{
16533+
"shape":"AgentConfig",
16534+
"documentation":"<p>The distribution of agents between the instance and its replica(s).</p>"
1629616535
}
1629716536
}
1629816537
},

0 commit comments

Comments
 (0)