Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListReplicationFindings

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.

Request Syntax


GET /replication-findings/InstanceId?maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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.

Length Constraints: Minimum length of 1. Maximum length of 250.

Pattern: ^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

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.

Length Constraints: Minimum length of 1. Maximum length of 100000.

ResourceType

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.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApproximateDriftedResourceCounts": [ 
      { 
         "Count": number,
         "Region": "string",
         "Timestamp": number
      }
   ],
   "NextToken": "string",
   "ReplicationFindingsList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "Message": "string",
         "Name": "string",
         "Operation": "string",
         "ReferenceCode": "string",
         "Region": "string",
         "ResourceType": "string"
      }
   ],
   "ResourceReplicationStatuses": [ 
      { 
         "Region": "string",
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApproximateDriftedResourceCounts

The approximate number of resources of the requested type that are not yet in sync, reported per AWS 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.

Type: Array of ApproximateDriftedResourceCount objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100000.

ReplicationFindingsList

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.

Type: Array of ReplicationFinding objects

ResourceReplicationStatuses

The replication status of the requested resource type in each AWS 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.

Type: Array of ResourceReplicationStatus objects

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429