DescribeArchive
Retrieves details about an archive.
Request Syntax
{
"ArchiveName": "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.
- ArchiveName
-
The name of the archive to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Response Syntax
{
"ArchiveArn": "string",
"ArchiveName": "string",
"CreationTime": number,
"Description": "string",
"EventCount": number,
"EventPattern": "string",
"EventSourceArn": "string",
"RetentionDays": number,
"SizeBytes": number,
"State": "string",
"StateReason": "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.
- ArchiveArn
-
The ARN of the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$ - ArchiveName
-
The name of the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[\.\-_A-Za-z0-9]+ - CreationTime
-
The time at which the archive was created.
Type: Timestamp
- Description
-
The description of the archive.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.* - EventCount
-
The number of events in the archive.
Type: Long
- EventPattern
-
The event pattern used to filter events sent to the archive.
Type: String
Length Constraints: Maximum length of 4096.
- EventSourceArn
-
The ARN of the event source associated with the archive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
- RetentionDays
-
The number of days to retain events for in the archive.
Type: Integer
Valid Range: Minimum value of 0.
- SizeBytes
-
The size of the archive in bytes.
Type: Long
- State
-
The state of the archive.
Type: String
Valid Values:
ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED - StateReason
-
The reason that the archive is in the state.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.*
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
- ResourceAlreadyExistsException
-
The resource you are trying to create already exists.
HTTP Status Code: 400
- 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 AWS SDKs, see the following:
