EventBridge / Client / update_event_bus

update_event_bus#

EventBridge.Client.update_event_bus(**kwargs)#

Updates the specified event bus.

See also: AWS API Documentation

Request Syntax

response = client.update_event_bus(
    Name='string',
    KmsKeyIdentifier='string',
    Description='string',
    DeadLetterConfig={
        'Arn': 'string'
    }
)
Parameters:

  • Name (string) – The name of the event bus.

  • 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 events on this event bus. 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 events on the event bus.

    For more information, see Managing keys in the Key Management Service Developer Guide.

    Note

    Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

    • You call CreateArchive on an event bus set to use a customer managed key for encryption.

    • You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

    • You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

    To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

  • Description (string) – The event bus description.

  • DeadLetterConfig (dict) –

    Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

    For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

    • Arn (string) –

      The ARN of the SQS queue specified as the target for the dead-letter queue.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'KmsKeyIdentifier': 'string',
    'Description': 'string',
    'DeadLetterConfig': {
        'Arn': 'string'
    }
}

Response Structure

  • (dict) –

    • Arn (string) –

      The event bus Amazon Resource Name (ARN).

    • Name (string) –

      The event bus name.

    • KmsKeyIdentifier (string) –

      The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.

      For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

    • Description (string) –

      The event bus description.

    • DeadLetterConfig (dict) –

      Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

      For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

      • Arn (string) –

        The ARN of the SQS queue specified as the target for the dead-letter queue.

Exceptions