EventBridge / Client / update_archive

update_archive

EventBridge.Client.update_archive(**kwargs)

Updates the specified archive.

See also: AWS API Documentation

Request Syntax

response = client.update_archive(
    ArchiveName='string',
    Description='string',
    EventPattern='string',
    RetentionDays=123,
    KmsKeyIdentifier='string'
)
Parameters:

  • ArchiveName (string) –

    [REQUIRED]

    The name of the archive to update.

  • Description (string) – The description for the archive.

  • EventPattern (string) – The event pattern to use to filter events sent to the archive.

  • RetentionDays (integer) – The number of days to retain events in the archive.

  • 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.

    • State (string) –

      The state of the archive.

    • StateReason (string) –

      The reason that the archive is in the current state.

    • CreationTime (datetime) –

      The time at which the archive was updated.

Exceptions