Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451299221.6 KB

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

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

Headers

X-Amz-Target'AWSEvents.CreateArchive' required

Request body

ArchiveNamestring required

The name for the archive to create.

EventSourceArnstring required

The ARN of the event bus that sends events to the archive.

Descriptionstring

A description for the archive.

EventPatternstring

An event pattern to use to filter events sent to the archive.

RetentionDaysinteger

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

Response

Success

ArchiveArnstring

The ARN of the archive that was created.

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

The state of the archive that was created.

StateReasonstring

The reason that the archive is in the state.

CreationTimestring date-time

The time at which the archive was created.