Amazon Connect Service

2026/10/22 - Amazon Connect Service - 1 new1 updated api methods

Changes  Adds support for customer queryable replication errors.

ListReplicationFindings (new) Link ¶

Lists replication findings for resources of a specified resource type in a specified Connect Customer instance. A replication finding describes a single resource whose replication to one or more Regions is incomplete or has encountered an error. Results are returned in pages. This operation is available only for instances that are set up for Global Resiliency.

See also: AWS API Documentation

Request Syntax

client.list_replication_findings(
    InstanceId='string',
    ResourceType='string',
    MaxResults=123,
    NextToken='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can provide either the instance ID or the full instance ARN. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceType:

string

param ResourceType:

[REQUIRED]

The type of resource to list replication findings for. The following values are currently supported: AGENT, AGENT_GROUP, AGENT_GROUP_LEVEL, AGENT_STATE, ATTRIBUTE, CONTACT_FLOW, DATA_TABLE, DATA_TABLE_ATTRIBUTE, DATA_TABLE_RECORD, DATA_TABLE_VALUE, FLOW_MODULE, FLOW_MODULE_ALIAS, FLOW_MODULE_VERSION, METRIC, NOTIFICATION, OPERATING_HOURS, PHONE_NUMBER, PROMPT, QUEUE, REPORT, ROUTING_PROFILE, SECURITY_PROFILE, TASK_TEMPLATE, TEST_CASE, TRANSFER_DESTINATION, VIEW, and WORKSPACE. Additional resource types can be supported over time. Specifying a value that is not currently supported returns an InvalidRequestException.

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.

rtype:

dict

returns:

Response Syntax

{
    'ReplicationFindingsList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Region': 'string',
            'ResourceType': 'string',
            'Name': 'string',
            'Operation': 'string',
            'ReferenceCode': 'string',
            'Message': 'string'
        },
    ],
    'ApproximateDriftedResourceCounts': [
        {
            'Region': 'string',
            'Count': 123,
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'ResourceReplicationStatuses': [
        {
            'Region': 'string',
            'Status': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • ReplicationFindingsList (list) --

      A list of replication findings for the requested resource type. Only findings that require your action are returned, so this list can be empty even when a drift count is nonzero. Results are paginated.

      • (dict) --

        Contains information about a resource that could not be replicated across the Regions of a Global Resiliency deployment, including the reason and any action required to resolve it.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the resource that the finding is for.

        • Id (string) --

          The identifier of the resource that the finding is for.

        • Region (string) --

          The Amazon Web Services Region that the finding was detected in.

        • ResourceType (string) --

          The type of resource that the finding is for, such as QUEUE or ROUTING_PROFILE.

        • Name (string) --

          The name of the resource that the finding is for.

        • Operation (string) --

          The replication operation that produced the finding, such as a create, update, or delete of the resource.

        • ReferenceCode (string) --

          A stable code that identifies the class of the finding. Use this code to look up the recommended steps to resolve the finding.

        • Message (string) --

          A human-readable description of the finding and the action, if any, required to resolve it.

    • ApproximateDriftedResourceCounts (list) --

      The approximate number of resources of the requested type that are not yet in sync, reported per Amazon Web Services Region. This count is independent of ReplicationFindingsList and can be higher than the number of findings returned. It is eventually consistent and can lag the current state of the instance. Each entry is the ApproximateDriftedResourceCount for one Region; a Region appears only when its count has been computed.

      • (dict) --

        Contains an approximate count of the resources of a given type that are not yet in sync in a Region, along with the time the count was last calculated.

        • Region (string) --

          The Amazon Web Services Region that the count applies to.

        • Count (integer) --

          The approximate number of resources of the requested type that are not yet in sync in the Region. A value of zero means the resources are in sync.

        • Timestamp (datetime) --

          The time, in Unix epoch time, when the count was last calculated.

    • NextToken (string) --

      If there are additional results, this is the token for retrieving the next page of ReplicationFindingsList.

    • ResourceReplicationStatuses (list) --

      The replication status of the requested resource type in each Amazon Web Services Region across which the Connect Customer instance is deployed for Global Resiliency, with one entry per Region. This set describes the overall replication state for the request and is returned in full on every page of results, so it does not change as you paginate.

      • (dict) --

        Indicates whether a resource type is being replicated and kept in sync in a specific Amazon Web Services Region of a Global Resiliency deployment.

        • Region (string) --

          The Amazon Web Services Region that the replication status applies to.

        • Status (string) --

          The replication status of the resource type in the Region, such as ENABLED, BLOCKED, or DISABLED.

GetTrafficDistribution (updated) Link ¶
Changes (response)
{'LastFailoverTime': 'timestamp'}

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

rtype:

dict

returns:

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
            },
        ]
    },
    'LastFailoverTime': datetime(2015, 1, 1)
}

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 that determines which Amazon Web Services Regions should be used to sign in agents in to both 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.

    • LastFailoverTime (datetime) --

      The timestamp of the most recent failover for the traffic distribution group. This value is updated each time UpdateTrafficDistribution is called to change the traffic distribution.