EventBridge / Client / create_archive

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.

Warning

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_archive(
    ArchiveName='string',
    EventSourceArn='string',
    Description='string',
    EventPattern='string',
    RetentionDays=123,
    KmsKeyIdentifier='string'
)
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

  • KmsKeyIdentifier (string) –

    The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

    If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

    For more information, see Identify and view keys in the Key Management Service Developer Guide.

    Warning

    If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

    For more information, see Encrypting archives in the Amazon EventBridge User Guide.

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