v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Retrieves details about an archive.

post/#X-Amz-Target=AWSEvents.DescribeArchive

Headers

X-Amz-Target'AWSEvents.DescribeArchive' required

Request body

ArchiveNamestring required

The name of the archive to retrieve.

Response

Success

ArchiveArnstring

The ARN of the archive.

ArchiveNamestring

The name of the archive.

EventSourceArnstring

The ARN of the event source associated with the archive.

Descriptionstring

The description of the archive.

EventPatternstring

The event pattern used to filter events sent to the archive.

State'ENABLED' | 'DISABLED' | 'CREATING' | 'UPDATING' | 'CREATE_FAILED' | 'UPDATE_FAILED'

The state of the archive.

StateReasonstring

The reason that the archive is in the state.

RetentionDaysinteger

The number of days to retain events for in the archive.

SizeBytesinteger

The size of the archive in bytes.

EventCountinteger

The number of events in the archive.

CreationTimestring date-time

The time at which the archive was created.