Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateEventBus

Updates the specified event bus.

Request Syntax


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DeadLetterConfig

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

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

Type: DeadLetterConfig object

Required: No

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

Required: No

KmsKeyIdentifier

The identifier of the Amazon 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 owned key to encrypt events on the event bus.

For more information, see Managing keys in the Amazon 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 owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

Name

The name of the event bus.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Required: No

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The event bus Amazon Resource Name (ARN).

Type: String

DeadLetterConfig

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

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

Type: DeadLetterConfig object

Description

The event bus description.

Type: String

Length Constraints: Maximum length of 512.

KmsKeyIdentifier

The identifier of the Amazon 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.

Type: String

Length Constraints: Maximum length of 2048.

Name

The event bus name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is concurrent modification on a rule, target, archive, or replay.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

OperationDisabledException

The operation you are attempting is not available in this region.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400