View a markdown version of this page

EventSourceSummary - Amazon EventBridge Custom Event Bus

EventSourceSummary

Summary of an EventSource, as returned by ListEventSources.

Contents

CreationTime

The time the EventSource was created.

Type: Timestamp

Required: No

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}

Required: No

EventSourceAccountId

AWS Account Id.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: No

EventSourceArn

EventSource ARN: event-sourcev2/<type>/<name>/<id>. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource's name. The id segment is a 25-character identifier generated by the service.

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-sourcev2\/(aws\.service|aws\.partner)\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

Required: No

LastModifiedTime

The time the EventSource was last modified.

Type: Timestamp

Required: No

Name

EventSource name. First character alphanumeric; the rest may add '.', '-', '_'. Names may not begin with the reserved "aws." prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2/<type>/<name>/<id>), mirroring EventBusName, so a name the ARN cannot represent cannot be created.

Type: String

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

Pattern: (?!aws\.)[A-Za-z0-9][\.\-_A-Za-z0-9]*

Required: No

Revoked

True when the bus owner has withdrawn this EventSource. Present only when true, so a bus owner listing EventSources sees at a glance which ones they revoked. See DescribeEventSourceResponse$Revoked.

Type: Boolean

Required: No

State

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | CREATE_FAILED | UPDATE_FAILED | DELETING | DELETE_FAILED

Required: No

Type

Origin type of an EventSource: an AWS service's events (AWS_SERVICE_EVENTS) or a partner event source's events (PARTNER_EVENTS).

Type: String

Valid Values: AWS_SERVICE_EVENTS | PARTNER_EVENTS

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: