DescribeSubscriber

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

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}):subscriber\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

Required: Yes

Batching configuration for a subscriber.

Type: BatchConfiguration object

The time the subscriber was created.

Type: Timestamp

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]).*

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}

Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty FilterConfiguration:{} clears the existing filter. Any non-empty shape (including {Language:X} without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.

Type: FilterConfiguration object

Configuration for how the subscriber invokes its target.

Type: InvokeConfiguration object

The time the subscriber was last modified.

Type: Timestamp

Log configuration for a subscriber.

Type: LogConfiguration object

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

Type: String

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

Pattern: [A-Za-z0-9][\.\-_A-Za-z0-9]*

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

Type: OnFailureConfiguration object

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

Type: PointInTimeConfiguration object

Retry policy for a subscriber.

Type: RetryPolicy object

True when the bus owner has revoked this subscriber. Present only when true, so an absent member means the subscriber is not revoked. Revocation is terminal: it never returns to false. Mutating operations on a revoked subscriber fail with InvalidStateException, except DeleteSubscriber, which stays available so a revoked subscriber can still be cleaned up.

Type: Boolean

Starting position for a subscriber.

Type: String

Valid Values: LATEST | POINT_IN_TIME

Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.

Type: String

Valid Values: RUNNING | STOPPED

The Amazon Resource Name (ARN) that uniquely identifies a subscriber.

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}):subscriber\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

Transformer configuration for a subscriber.

Type: Transformer object

Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.

Type: String

Valid Values: FIFO | UNORDERED

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

The request failed because of an internal service error. Retry the request.

HTTP Status Code: 500

A request parameter is missing or not valid.

HTTP Status Code: 400

The resource does not exist.

HTTP Status Code: 404

The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

HTTP Status Code: 429