Connect / Paginator / ListReplicationFindings

ListReplicationFindings¶

class Connect.Paginator.ListReplicationFindings¶

paginator = client.get_paginator('list_replication_findings')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Connect.Client.list_replication_findings().

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ResourceType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

InstanceId (string) –
[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.
ResourceType (string) –
[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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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