Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Aggregation
Detail Provides detailed information about the dimensions used for aggregation.
- Aggregation
Key Key-value collection that indicate how notifications are grouped.
- Aggregation
Summary Provides additional information about the aggregation key.
- Dimension
The key-value pair of properties for an event.
- Event
Rule Status Summary Provides additional information about the current
EventRule
status.- Event
Rule Structure Contains a complete list of fields related to an
EventRule
.- Managed
Notification Channel Association Summary Provides a summary of channel associations for a managed notification configuration.
- Managed
Notification Child Event A ManagedNotificationChildEvent is a notification-focused representation of an event. They contain semantic information used to create aggregated or non-aggregated end-user notifications.
- Managed
Notification Child Event Overview Describes an overview and metadata for a
ManagedNotificationChildEvent
.- Managed
Notification Child Event Summary Describes a short summary and metadata for a
ManagedNotificationChildEvent
.- Managed
Notification Configuration Structure Describes the basic structure and properties of a
ManagedNotificationConfiguration
.- Managed
Notification Event A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.
- Managed
Notification Event Overview Describes an overview and metadata for a ManagedNotificationEvent.
- Managed
Notification Event Summary A short summary of a
ManagedNotificationEvent
. This is only used when listing managed notification events.- Managed
Source Event Metadata Summary A short summary and metadata for a managed notification event.
- Media
Element Describes a media element.
- Message
Components Describes the components of a notification message.
- Message
Components Summary Contains the headline message component.
- Notification
Configuration Structure Contains the complete list of fields for a NotificationConfiguration.
- Notification
Event Overview Describes a short summary of a
NotificationEvent
. This is only used when listing notification events.- Notification
Event Schema A
NotificationEvent
is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.- Notification
Event Summary Describes a short summary and metadata for a
NotificationEvent
.- Notification
HubOverview Describes an overview of a
NotificationHub
.A
NotificationConfiguration
is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.- Notification
HubStatus Summary Provides additional information about the current
NotificationHub
status.- Notifications
Access ForOrganization Orgs Service trust for User Notifications.
- Resource
A resource affected by or closely linked to an event.
- Source
Event Metadata Describes the metadata for a source event.
For more information, see Event structure reference in the Amazon EventBridge User Guide.
- Source
Event Metadata Summary Contains metadata about the event that caused the
NotificationEvent
. For other specific values, seesourceEventMetadata
.- Summarization
Dimension Detail Provides detailed information about the dimensions used for event summarization and aggregation.
- Summarization
Dimension Overview Provides an overview of how data is summarized across different dimensions.
- Text
Part Value Describes text information objects containing fields that determine how text part objects are composed.
- Validation
Exception Field Stores information about a field passed inside a request that resulted in an exception.
Enums§
- Access
Status - When writing a match expression against
AccessStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Account
Contact Type - When writing a match expression against
AccountContactType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Aggregation
Duration - When writing a match expression against
AggregationDuration
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Aggregation
Event Type - When writing a match expression against
AggregationEventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Channel
Association Override Option - When writing a match expression against
ChannelAssociationOverrideOption
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Channel
Type - When writing a match expression against
ChannelType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Rule Status - When writing a match expression against
EventRuleStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Status - When writing a match expression against
EventStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Locale
Code - When writing a match expression against
LocaleCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Media
Element Type - When writing a match expression against
MediaElementType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Notification
Configuration Status - When writing a match expression against
NotificationConfigurationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Notification
HubStatus - When writing a match expression against
NotificationHubStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Notification
Type - When writing a match expression against
NotificationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Version - When writing a match expression against
SchemaVersion
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Text
Part Type - When writing a match expression against
TextPartType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Validation
Exception Reason - When writing a match expression against
ValidationExceptionReason
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.