2023/08/10 - Amazon Connect Service - 3 new 4 updated api methods
Changes This release adds APIs to provision agents that are global / available in multiple AWS regions and distribute them across these regions by percentage.
Lists traffic distribution group users.
See also: AWS API Documentation
Request Syntax
client.list_traffic_distribution_group_users(
TrafficDistributionGroupId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
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.
integer
The maximum number of results to return per page.
string
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.
dict
Response Syntax
{
'NextToken': 'string',
'TrafficDistributionGroupUserSummaryList': [
{
'UserId': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
TrafficDistributionGroupUserSummaryList (list) --
A list of traffic distribution group users.
(dict) --
Summary information about a traffic distribution group user.
UserId (string) --
The identifier for the user. This can be the ID or the ARN of the user.
Disassociates an agent from a traffic distribution group.
See also: AWS API Documentation
Request Syntax
client.disassociate_traffic_distribution_group_user(
TrafficDistributionGroupId='string',
UserId='string',
InstanceId='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
The identifier for the user. This can be the ID or the ARN of the user.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates an agent with a traffic distribution group.
See also: AWS API Documentation
Request Syntax
client.associate_traffic_distribution_group_user(
TrafficDistributionGroupId='string',
UserId='string',
InstanceId='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
The identifier of the user account. This can be the ID or the ARN of the user.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{}
Response Structure
(dict) --
{'TrafficDistributionGroup': {'IsDefault': 'boolean'}}
Gets details and status of a traffic distribution group.
See also: AWS API Documentation
Request Syntax
client.describe_traffic_distribution_group(
TrafficDistributionGroupId='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'TrafficDistributionGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'InstanceArn': 'string',
'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS',
'Tags': {
'string': 'string'
},
'IsDefault': True|False
}
}
Response Structure
(dict) --
TrafficDistributionGroup (dict) --
Information about the traffic distribution group.
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Name (string) --
The name of the traffic distribution group.
Description (string) --
The description of the traffic distribution group.
InstanceArn (string) --
The Amazon Resource Name (ARN).
Status (string) --
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
IsDefault (boolean) --
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.
Note
You can change the SignInConfig only for a default TrafficDistributionGroup . If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup , an InvalidRequestException is returned.
{'AgentConfig': {'Distributions': [{'Percentage': 'integer',
'Region': 'string'}]},
'SignInConfig': {'Distributions': [{'Enabled': 'boolean',
'Region': 'string'}]}}
Retrieves the current traffic distribution for a given traffic distribution group.
See also: AWS API Documentation
Request Syntax
client.get_traffic_distribution(
Id='string'
)
string
[REQUIRED]
The identifier of the traffic distribution group.
dict
Response Syntax
{
'TelephonyConfig': {
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
},
'Id': 'string',
'Arn': 'string',
'SignInConfig': {
'Distributions': [
{
'Region': 'string',
'Enabled': True|False
},
]
},
'AgentConfig': {
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
}
}
Response Structure
(dict) --
TelephonyConfig (dict) --
The distribution of traffic between the instance and its replicas.
Distributions (list) --
Information about traffic distributions.
(dict) --
Information about a traffic distribution.
Region (string) --
The Amazon Web Services Region where the traffic is distributed.
Percentage (integer) --
The percentage of the traffic that is distributed, in increments of 10.
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
SignInConfig (dict) --
The distribution of allowing signing in to the instance and its replica(s).
Distributions (list) --
Information about traffic distributions.
(dict) --
The distribution of sign in traffic between the instance and its replica(s).
Region (string) --
The Amazon Web Services Region of the sign in distribution.
Enabled (boolean) --
Whether sign in distribution is enabled.
AgentConfig (dict) --
The distribution of agents between the instance and its replica(s).
Distributions (list) --
Information about traffic distributions.
(dict) --
Information about a traffic distribution.
Region (string) --
The Amazon Web Services Region where the traffic is distributed.
Percentage (integer) --
The percentage of the traffic that is distributed, in increments of 10.
{'TrafficDistributionGroupSummaryList': {'IsDefault': 'boolean'}}
Lists traffic distribution groups.
See also: AWS API Documentation
Request Syntax
client.list_traffic_distribution_groups(
MaxResults=123,
NextToken='string',
InstanceId='string'
)
integer
The maximum number of results to return per page.
string
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.
string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'NextToken': 'string',
'TrafficDistributionGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'InstanceArn': 'string',
'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS',
'IsDefault': True|False
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
TrafficDistributionGroupSummaryList (list) --
A list of traffic distribution groups.
(dict) --
Information about traffic distribution groups.
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Name (string) --
The name of the traffic distribution group.
InstanceArn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Status (string) --
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
IsDefault (boolean) --
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.
{'AgentConfig': {'Distributions': [{'Percentage': 'integer',
'Region': 'string'}]},
'SignInConfig': {'Distributions': [{'Enabled': 'boolean',
'Region': 'string'}]}}
Updates the traffic distribution for a given traffic distribution group.
Note
You can change the SignInConfig only for a default TrafficDistributionGroup . If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup , an InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.update_traffic_distribution(
Id='string',
TelephonyConfig={
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
},
SignInConfig={
'Distributions': [
{
'Region': 'string',
'Enabled': True|False
},
]
},
AgentConfig={
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
}
)
string
[REQUIRED]
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.
dict
The distribution of traffic between the instance and its replica(s).
Distributions (list) -- [REQUIRED]
Information about traffic distributions.
(dict) --
Information about a traffic distribution.
Region (string) -- [REQUIRED]
The Amazon Web Services Region where the traffic is distributed.
Percentage (integer) -- [REQUIRED]
The percentage of the traffic that is distributed, in increments of 10.
dict
The distribution of allowing signing in to the instance and its replica(s).
Distributions (list) -- [REQUIRED]
Information about traffic distributions.
(dict) --
The distribution of sign in traffic between the instance and its replica(s).
Region (string) -- [REQUIRED]
The Amazon Web Services Region of the sign in distribution.
Enabled (boolean) -- [REQUIRED]
Whether sign in distribution is enabled.
dict
The distribution of agents between the instance and its replica(s).
Distributions (list) -- [REQUIRED]
Information about traffic distributions.
(dict) --
Information about a traffic distribution.
Region (string) -- [REQUIRED]
The Amazon Web Services Region where the traffic is distributed.
Percentage (integer) -- [REQUIRED]
The percentage of the traffic that is distributed, in increments of 10.
dict
Response Syntax
{}
Response Structure
(dict) --