SubscriberSummary
Summary of a subscriber, as returned by ListSubscribers.
Contents
- CreationTime
-
The time the subscriber 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
- LastModifiedTime
-
The time the subscriber was last modified.
Type: Timestamp
Required: No
- Name
-
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]*Required: No
- Revoked
-
True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.
Type: Boolean
Required: No
- State
-
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 | STOPPEDRequired: No
- SubscriberAccountId
-
AWS Account Id.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12}Required: No
- SubscriberArn
-
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: No
- TargetArn
-
ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
arn:aws(-[a-z0-9]+)*:[^\s]+(?![\s\S]).*Required: No
- Type
-
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 | UNORDEREDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: