AWS API Changes

2025/04/04 - Amazon EventBridge - 3 updated api methods

Changes Amazon EventBridge adds support for customer-managed keys on Archives and validations for two fields: eventSourceArn and kmsKeyIdentifier.

CreateArchive (updated)

Link ¶
Changes (request)

{'KmsKeyIdentifier': 'string'}

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

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

type ArchiveName:

string

param ArchiveName:

[REQUIRED]

The name for the archive to create.

type EventSourceArn:

string

param EventSourceArn:

[REQUIRED]

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

type Description:

string

param Description:

A description for the archive.

type EventPattern:

string

param EventPattern:

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

type RetentionDays:

integer

param RetentionDays:

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

type KmsKeyIdentifier:

string

param KmsKeyIdentifier:

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.

rtype:

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.

DescribeArchive (updated)

Link ¶
Changes (response)

{'KmsKeyIdentifier': 'string'}

Retrieves details about an archive.

See also: AWS API Documentation

Request Syntax

client.describe_archive(
    ArchiveName='string'
)

type ArchiveName:

string

param ArchiveName:

[REQUIRED]

The name of the archive to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'ArchiveArn': 'string',
    'ArchiveName': 'string',
    'EventSourceArn': 'string',
    'Description': 'string',
    'EventPattern': 'string',
    'State': 'ENABLED'|'DISABLED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED',
    'StateReason': 'string',
    'KmsKeyIdentifier': 'string',
    'RetentionDays': 123,
    'SizeBytes': 123,
    'EventCount': 123,
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- ArchiveArn (string) --
  
  The ARN of the archive.
- ArchiveName (string) --
  
  The name of the archive.
- EventSourceArn (string) --
  
  The ARN of the event source associated with the archive.
- Description (string) --
  
  The description of the archive.
- EventPattern (string) --
  
  The event pattern used to filter events sent to the archive.
- State (string) --
  
  The state of the archive.
- StateReason (string) --
  
  The reason that the archive is in the state.
- KmsKeyIdentifier (string) --
  
  The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.
  
  For more information, see Encrypting archives in the Amazon EventBridge User Guide.
- RetentionDays (integer) --
  
  The number of days to retain events for in the archive.
- SizeBytes (integer) --
  
  The size of the archive in bytes.
- EventCount (integer) --
  
  The number of events in the archive.
- CreationTime (datetime) --
  
  The time at which the archive was created.

UpdateArchive (updated)

Link ¶
Changes (request)

{'KmsKeyIdentifier': 'string'}

Updates the specified archive.

See also: AWS API Documentation

Request Syntax

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

type ArchiveName:

string

param ArchiveName:

[REQUIRED]

The name of the archive to update.

type Description:

string

param Description:

The description for the archive.

type EventPattern:

string

param EventPattern:

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

type RetentionDays:

integer

param RetentionDays:

The number of days to retain events in the archive.

type KmsKeyIdentifier:

string

param KmsKeyIdentifier:

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.

rtype:

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.