Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSnapshotCopyConfigurations

Returns a list of snapshot copy configurations.

Request Syntax


{
   "maxResults": number,
   "namespaceName": "string",
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

Type: Integer

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

Required: No

namespaceName

The namespace from which to list all snapshot copy configurations.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: No

nextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

Required: No

Response Syntax


{
   "nextToken": "string",
   "snapshotCopyConfigurations": [ 
      { 
         "destinationKmsKeyId": "string",
         "destinationRegion": "string",
         "namespaceName": "string",
         "snapshotCopyConfigurationArn": "string",
         "snapshotCopyConfigurationId": "string",
         "snapshotRetentionPeriod": number
      }
   ]
}

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.

nextToken

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

snapshotCopyConfigurations

All of the returned snapshot copy configurations.

Type: Array of SnapshotCopyConfiguration objects

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

Errors

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

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidPaginationException

The provided pagination token is invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400