CreateEventBus
Creates an event bus. Provisioning is asynchronous: the bus is returned in the CREATING state and transitions to ACTIVE when ready (see the EventBusActive waiter). Retries carrying the same ClientToken are idempotent.
Request Parameters
- ClientToken
-
Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\u0021-\u007E]+Required: No
- Description
-
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
[^\u0000-\u001F\u007F-\u009F\u2028\u2029]*(?![\s\S]).*Required: No
- EncryptionConfiguration
-
Encryption configuration for an event bus.
Type: EncryptionConfiguration object
Required: No
- Name
-
Name of an event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'. The grammar matches the name segment of EventBusArn (event-busv2/<name>/<id>), so every valid name can be represented in the bus's ARN. The same type is used everywhere a bus name appears.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9][\.\-_A-Za-z0-9]*Required: Yes
- StorageConfiguration
-
Event storage configuration for an event bus.
Type: StorageConfiguration object
Required: No
- Tags
-
Tags attached to a resource, as key-value pairs.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
\S([\s\S]*\S)?(?![\s\S]).*Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
(\S([\s\S]*\S)?)?(?![\s\S]).*Required: No
Response Elements
The following elements are returned by the service.
- CreationTime
-
The time the event bus was created.
Type: Timestamp
- Description
-
Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
[^\u0000-\u001F\u007F-\u009F\u2028\u2029]*(?![\s\S]).* - EncryptionConfiguration
-
Encryption configuration for an event bus.
Type: EncryptionConfiguration object
- EventBusArn
-
The Amazon Resource Name (ARN) that uniquely identifies an event bus.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-busv2\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25} - Name
-
Name of an event bus. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'. The grammar matches the name segment of EventBusArn (event-busv2/<name>/<id>), so every valid name can be represented in the bus's ARN. The same type is used everywhere a bus name appears.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9][\.\-_A-Za-z0-9]* - State
-
Lifecycle state of an event bus.
-
CREATING: Bus creation is in progress.
-
CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
-
ACTIVE: Bus is fully operational and can accept events.
-
UPDATING: Bus update is in progress.
-
UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
-
DELETING: Bus deletion is actively in progress.
-
DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.
Type: String
Valid Values:
CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | DELETING | ACTIVE | DELETE_FAILED -
- StateReason
-
Human-readable explanation of why an event bus is in its current State. Omitted when the bus is in a normal operational state (ACTIVE). It stands in for the error response an asynchronous failure cannot return, so it applies only to resources with an asynchronous lifecycle: event buses. EventSources and subscribers are provisioned synchronously and report failures directly on the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
- StorageConfiguration
-
Event storage configuration of an event bus, as returned on reads.
Type: StorageConfigurationOutput object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
HTTP Status Code: 403
- ConcurrentModificationException
-
Another change to the resource is already in progress. Retry the request.
HTTP Status Code: 409
- IdempotentParameterMismatchException
-
The request reuses the client token of an earlier request with different parameters. Use a new client token, or resend the earlier request unchanged.
HTTP Status Code: 409
- InternalException
-
The request failed because of an internal service error. Retry the request.
HTTP Status Code: 500
- InvalidInputException
-
A request parameter is missing or not valid.
HTTP Status Code: 400
- InvalidStateException
-
The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.
HTTP Status Code: 409
- LimitExceededException
-
The request would exceed a service quota for the account.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
A resource with the same name already exists.
HTTP Status Code: 409
- ThrottlingException
-
The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
