create_archive

EventBridge.Client.create_archive(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_archive(
    ArchiveName='string',
    EventSourceArn='string',
    Description='string',
    EventPattern='string',
    RetentionDays=123
)

Parameters

• ArchiveName (string) --

  [REQUIRED]

  The name for the archive to create.

• EventSourceArn (string) --

  [REQUIRED]

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

• Description (string) -- A description for the archive.
• EventPattern (string) -- An event pattern to use to filter events sent to the archive.
• RetentionDays (integer) -- The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

Return type

dict

Returns

Response Syntax

{
    'ArchiveArn': 'string',
    'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'StateReason': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • ArchiveArn (string) --

    The ARN of the archive that was created.

  • State (string) --

    The state of the archive that was created.

  • StateReason (string) --

    The reason that the archive is in the state.

  • CreationTime (datetime) --

    The time at which the archive was created.

Exceptions

• EventBridge.Client.exceptions.ConcurrentModificationException
• EventBridge.Client.exceptions.ResourceAlreadyExistsException
• EventBridge.Client.exceptions.ResourceNotFoundException
• EventBridge.Client.exceptions.InternalException
• EventBridge.Client.exceptions.LimitExceededException
• EventBridge.Client.exceptions.InvalidEventPatternException