ListArchives
Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.
Request Syntax
{
"EventSourceArn": "string
",
"Limit": number
,
"NamePrefix": "string
",
"NextToken": "string
",
"State": "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.
- EventSourceArn
-
The ARN of the event source associated with the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
- Limit
-
The maximum number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NamePrefix
-
A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[\.\-_A-Za-z0-9]+
Required: No
- NextToken
-
The token returned by a previous call to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- State
-
The state of the archive.
Type: String
Valid Values:
ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED
Required: No
Response Syntax
{
"Archives": [
{
"ArchiveName": "string",
"CreationTime": number,
"EventCount": number,
"EventSourceArn": "string",
"RetentionDays": number,
"SizeBytes": number,
"State": "string",
"StateReason": "string"
}
],
"NextToken": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: