AWS API Changes

2022/10/19 - Amazon Connect Service - 7 new api methods

Changes This release adds API support for managing phone numbers that can be used across multiple AWS regions through telephony traffic distribution.

ListTrafficDistributionGroups (new)

Link ¶

Lists traffic distribution groups.

See also: AWS API Documentation

Request Syntax

client.list_traffic_distribution_groups(
    MaxResults=123,
    NextToken='string',
    InstanceId='string'
)

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type NextToken

string

param NextToken

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.

type InstanceId

string

param InstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

rtype

dict

returns

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'
        },
    ]
}

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.

ReplicateInstance (new)

Link ¶

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.replicate_instance(
    InstanceId='string',
    ReplicaRegion='string',
    ClientToken='string',
    ReplicaAlias='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ReplicaRegion

string

param ReplicaRegion

[REQUIRED]

The Amazon Web Services Region where to replicate the Amazon Connect instance.

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type ReplicaAlias

string

param ReplicaAlias

[REQUIRED]

The alias for the replicated instance. The ReplicaAlias must be unique.

rtype

dict

returns

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

(dict) --
- Id (string) --
  
  The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the replicated instance.

CreateTrafficDistributionGroup (new)

Link ¶

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.create_traffic_distribution_group(
    Name='string',
    Description='string',
    InstanceId='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

[REQUIRED]

The name for the traffic distribution group.

type Description

string

param Description

A description for the traffic distribution group.

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

type ClientToken

string

param ClientToken

This field is autopopulated if not provided.

type Tags

dict

param Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

(dict) --
- 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.

UpdateTrafficDistribution (new)

Link ¶

Updates the traffic distribution for a given traffic distribution group. 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
            },
        ]
    }
)

type Id

string

param Id

[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.

type TelephonyConfig

dict

param TelephonyConfig

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteTrafficDistributionGroup (new)

Link ¶

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.delete_traffic_distribution_group(
    TrafficDistributionGroupId='string'
)

type TrafficDistributionGroupId

string

param TrafficDistributionGroupId

[REQUIRED]

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeTrafficDistributionGroup (new)

Link ¶

Gets details and status of a traffic distribution group.

See also: AWS API Documentation

Request Syntax

client.describe_traffic_distribution_group(
    TrafficDistributionGroupId='string'
)

type TrafficDistributionGroupId

string

param TrafficDistributionGroupId

[REQUIRED]

rtype

dict

returns

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'
        }
    }
}

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) --

GetTrafficDistribution (new)

Link ¶

Retrieves the current traffic distribution for a given traffic distribution group.

See also: AWS API Documentation

Request Syntax

client.get_traffic_distribution(
    Id='string'
)

type Id

string

param Id

[REQUIRED]

The identifier of the traffic distribution group.

rtype

dict

returns

Response Syntax

{
    'TelephonyConfig': {
        'Distributions': [
            {
                'Region': 'string',
                'Percentage': 123
            },
        ]
    },
    'Id': 'string',
    'Arn': 'string'
}

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.