list-replication-findings¶

Description¶

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.

Synopsis¶

  list-replication-findings
--instance-id <value>
--resource-type <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--instance-id (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.

Constraints:

min: 1

max: 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}$

--resource-type (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 .

Constraints:

min: 1

max: 128

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

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.

(structure)

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) [required]

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

Id -> (string) [required]

The identifier of the resource that the finding is for.

Constraints:

min: 1

max: 500

Region -> (string)

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

Constraints:

min: 8

max: 31

pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

ResourceType -> (string) [required]

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

Constraints:

min: 1

max: 128

Name -> (string)

The name of the resource that the finding is for.

Constraints:

min: 1

max: 512

Operation -> (string)

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

Constraints:

min: 1

max: 256

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.

Constraints:

min: 1

max: 256

Message -> (string)

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

Constraints:

max: 4096

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.

Constraints:

min: 1

max: 2

(structure)

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) [required]

The Amazon Web Services Region that the count applies to.

Constraints:

min: 8

max: 31

pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

Count -> (long) [required]

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 -> (timestamp) [required]

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 .

Constraints:

min: 1

max: 100000

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.

Constraints:

min: 1

max: 2

(structure)

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) [required]

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

Constraints:

min: 8

max: 31

pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

Status -> (string) [required]

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

Constraints:

min: 1

max: 128

Table of Contents

Feedback

User Guide