{ "version": "2.0", "service": "

The User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notifications API actions.

User Notification control plane APIs are currently available in US East (Virginia) - us-east-1.

GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.

The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).

For information about descriptions, API request parameters, and the JSON response for email contact related API actions, see the User Notifications Contacts API Reference Guide.

", "operations": { "AssociateChannel": "

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "AssociateManagedNotificationAccountContact": "

Associates an Account Contact with a particular ManagedNotificationConfiguration.

", "AssociateManagedNotificationAdditionalChannel": "

Associates an additional Channel with a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "AssociateOrganizationalUnit": "

Associates an organizational unit with a notification configuration.

", "CreateEventRule": "

Creates an EventRule that is associated with a specified NotificationConfiguration.

", "CreateNotificationConfiguration": "

Creates a new NotificationConfiguration.

", "DeleteEventRule": "

Deletes an EventRule.

", "DeleteNotificationConfiguration": "

Deletes a NotificationConfiguration.

", "DeregisterNotificationHub": "

Deregisters a NotificationConfiguration in the specified Region.

You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.

", "DisableNotificationsAccessForOrganization": "

Disables service trust between User Notifications and Amazon Web Services Organizations.

", "DisassociateChannel": "

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "DisassociateManagedNotificationAccountContact": "

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

", "DisassociateManagedNotificationAdditionalChannel": "

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "DisassociateOrganizationalUnit": "

Removes the association between an organizational unit and a notification configuration.

", "EnableNotificationsAccessForOrganization": "

Enables service trust between User Notifications and Amazon Web Services Organizations.

", "GetEventRule": "

Returns a specified EventRule.

", "GetManagedNotificationChildEvent": "

Returns the child event of a specific given ManagedNotificationEvent.

", "GetManagedNotificationConfiguration": "

Returns a specified ManagedNotificationConfiguration.

", "GetManagedNotificationEvent": "

Returns a specified ManagedNotificationEvent.

", "GetNotificationConfiguration": "

Returns a specified NotificationConfiguration.

", "GetNotificationEvent": "

Returns a specified NotificationEvent.

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

", "GetNotificationsAccessForOrganization": "

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

", "ListChannels": "

Returns a list of Channels for a NotificationConfiguration.

", "ListEventRules": "

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

", "ListManagedNotificationChannelAssociations": "

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.

", "ListManagedNotificationChildEvents": "

Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order (newest first).

", "ListManagedNotificationConfigurations": "

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

", "ListManagedNotificationEvents": "

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

", "ListMemberAccounts": "

Returns a list of member accounts associated with a notification configuration.

", "ListNotificationConfigurations": "

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

", "ListNotificationEvents": "

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

", "ListNotificationHubs": "

Returns a list of NotificationHubs.

", "ListOrganizationalUnits": "

Returns a list of organizational units associated with a notification configuration.

", "ListTagsForResource": "

Returns a list of tags for a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations.

", "RegisterNotificationHub": "

Registers a NotificationConfiguration in the specified Region.

There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.

", "TagResource": "

Tags the resource with a tag key and value.

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations.

", "UntagResource": "

Untags a resource with a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

", "UpdateEventRule": "

Updates an existing EventRule.

", "UpdateNotificationConfiguration": "

Updates a NotificationConfiguration.

" }, "shapes": { "AccessDeniedException": { "base": "

User does not have sufficient access to perform this action.

", "refs": {} }, "AccessStatus": { "base": null, "refs": { "NotificationsAccessForOrganization$accessStatus": "

Access Status for the Orgs Service.

" } }, "AccountContactType": { "base": null, "refs": { "AssociateManagedNotificationAccountContactRequest$contactIdentifier": "

A unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.

", "DisassociateManagedNotificationAccountContactRequest$contactIdentifier": "

The unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.

" } }, "AccountId": { "base": null, "refs": { "ListManagedNotificationChildEventsRequest$relatedAccount": "

The Amazon Web Services account ID associated with the Managed Notification Child Events.

", "ListManagedNotificationEventsRequest$relatedAccount": "

The Amazon Web Services account ID associated with the Managed Notification Events.

", "ListMemberAccountsRequest$memberAccount": "

The member account identifier used to filter the results.

", "ManagedNotificationChildEventOverview$relatedAccount": "

The account that related to the ManagedNotificationChildEvent.

", "ManagedNotificationEventOverview$relatedAccount": "

The account that related to the ManagedNotificationEvent.

", "MemberAccount$accountId": "

The AWS account ID of the member account.

", "NotificationEventOverview$relatedAccount": "

The account name containing the NotificationHub.

" } }, "AggregatedNotificationRegions": { "base": null, "refs": { "ManagedNotificationEventOverview$aggregatedNotificationRegions": "

The list of the regions where the aggregated notifications in this NotificationEvent originated.

" } }, "AggregationDetail": { "base": "

Provides detailed information about the dimensions used for aggregation.

", "refs": { "ManagedNotificationChildEvent$aggregationDetail": "

Provides detailed information about the dimensions used for event summarization and aggregation.

", "ManagedNotificationChildEventSummary$aggregationDetail": "

Provides detailed information about the dimensions used for event summarization and aggregation.

" } }, "AggregationDuration": { "base": null, "refs": { "CreateNotificationConfigurationRequest$aggregationDuration": "

The aggregation preference of the NotificationConfiguration.

", "GetNotificationConfigurationResponse$aggregationDuration": "

The aggregation preference of the NotificationConfiguration.

", "NotificationConfigurationStructure$aggregationDuration": "

The aggregation preference of the NotificationConfiguration.

", "UpdateNotificationConfigurationRequest$aggregationDuration": "

The aggregation preference of the NotificationConfiguration.

" } }, "AggregationEventType": { "base": null, "refs": { "ManagedNotificationEvent$aggregationEventType": "

The notifications aggregation type.

", "ManagedNotificationEventOverview$aggregationEventType": "

The notifications aggregation type.

", "NotificationEvent$aggregationEventType": "

The aggregation type of the NotificationConfiguration.

", "NotificationEventOverview$aggregationEventType": "

The NotificationConfiguration's aggregation type.

" } }, "AggregationKey": { "base": "

Key-value collection that indicate how notifications are grouped.

", "refs": { "AggregationKeys$member": null } }, "AggregationKeys": { "base": null, "refs": { "AggregationSummary$aggregatedBy": "

Indicates the criteria or rules by which notifications have been grouped together.

" } }, "AggregationSummary": { "base": "

Provides additional information about the aggregation key.

", "refs": { "ManagedNotificationEvent$aggregationSummary": null, "ManagedNotificationEventOverview$aggregationSummary": null, "NotificationEvent$aggregationSummary": "

Provides additional information about how multiple notifications are grouped.

", "NotificationEventOverview$aggregationSummary": "

Provides an aggregated summary data for notification events.

" } }, "Arn": { "base": null, "refs": { "Resource$arn": "

The Amazon Resource Name (ARN) of the resource. At least one id or ARN is required.

" } }, "AssociateChannelRequest": { "base": null, "refs": {} }, "AssociateChannelResponse": { "base": null, "refs": {} }, "AssociateManagedNotificationAccountContactRequest": { "base": null, "refs": {} }, "AssociateManagedNotificationAccountContactResponse": { "base": null, "refs": {} }, "AssociateManagedNotificationAdditionalChannelRequest": { "base": null, "refs": {} }, "AssociateManagedNotificationAdditionalChannelResponse": { "base": null, "refs": {} }, "AssociateOrganizationalUnitRequest": { "base": null, "refs": {} }, "AssociateOrganizationalUnitResponse": { "base": null, "refs": {} }, "Boolean": { "base": null, "refs": { "ListNotificationEventsRequest$includeChildEvents": "

Include aggregated child events in the result.

" } }, "ChannelArn": { "base": null, "refs": { "AssociateChannelRequest$arn": "

The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.

Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.

", "AssociateManagedNotificationAdditionalChannelRequest$channelArn": "

The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and email (notifications-contacts).

", "Channels$member": null, "DisassociateChannelRequest$arn": "

The Amazon Resource Name (ARN) of the Channel to disassociate.

", "DisassociateManagedNotificationAdditionalChannelRequest$channelArn": "

The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

", "ListNotificationConfigurationsRequest$channelArn": "

The Amazon Resource Name (ARN) of the Channel to match.

" } }, "ChannelAssociationOverrideOption": { "base": null, "refs": { "ManagedNotificationChannelAssociationSummary$overrideOption": "

Controls whether users can modify channel associations for a notification configuration.

" } }, "ChannelIdentifier": { "base": null, "refs": { "ListManagedNotificationConfigurationsRequest$channelIdentifier": "

The identifier or ARN of the notification channel to filter configurations by.

" } }, "ChannelType": { "base": null, "refs": { "ManagedNotificationChannelAssociationSummary$channelType": "

The type of notification channel used for message delivery.

" } }, "Channels": { "base": null, "refs": { "ListChannelsResponse$channels": "

A list of Channels.

" } }, "ConflictException": { "base": "

Updating or deleting a resource can cause an inconsistent state.

", "refs": {} }, "CreateEventRuleRequest": { "base": null, "refs": {} }, "CreateEventRuleResponse": { "base": null, "refs": {} }, "CreateNotificationConfigurationRequest": { "base": null, "refs": {} }, "CreateNotificationConfigurationResponse": { "base": null, "refs": {} }, "CreationTime": { "base": null, "refs": { "EventRuleStructure$creationTime": "

The creation time of the EventRule.

", "GetEventRuleResponse$creationTime": "

The date when the EventRule was created.

", "GetManagedNotificationChildEventResponse$creationTime": "

The creation time of the ManagedNotificationChildEvent.

", "GetManagedNotificationEventResponse$creationTime": "

The creation time of the ManagedNotificationEvent.

", "GetNotificationConfigurationResponse$creationTime": "

The creation time of the NotificationConfiguration.

", "GetNotificationEventResponse$creationTime": "

The creation time of the NotificationEvent.

", "ManagedNotificationChildEventOverview$creationTime": "

The creation time of the ManagedNotificationChildEvent.

", "ManagedNotificationEventOverview$creationTime": "

The creation time of the ManagedNotificationEvent.

", "NotificationConfigurationStructure$creationTime": "

The creation time of the NotificationConfiguration.

", "NotificationEventOverview$creationTime": "

The creation time of the NotificationEvent.

", "NotificationHubOverview$creationTime": "

The date and time the NotificationHubOverview was created.

", "RegisterNotificationHubResponse$creationTime": "

The date the resource was created.

" } }, "DeleteEventRuleRequest": { "base": null, "refs": {} }, "DeleteEventRuleResponse": { "base": null, "refs": {} }, "DeleteNotificationConfigurationRequest": { "base": null, "refs": {} }, "DeleteNotificationConfigurationResponse": { "base": null, "refs": {} }, "DeregisterNotificationHubRequest": { "base": null, "refs": {} }, "DeregisterNotificationHubResponse": { "base": null, "refs": {} }, "Dimension": { "base": "

The key-value pair of properties for an event.

", "refs": { "Dimensions$member": null } }, "Dimensions": { "base": null, "refs": { "MessageComponents$dimensions": "

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Included dimensions, keys, and values are subject to change.

" } }, "DisableNotificationsAccessForOrganizationRequest": { "base": null, "refs": {} }, "DisableNotificationsAccessForOrganizationResponse": { "base": null, "refs": {} }, "DisassociateChannelRequest": { "base": null, "refs": {} }, "DisassociateChannelResponse": { "base": null, "refs": {} }, "DisassociateManagedNotificationAccountContactRequest": { "base": null, "refs": {} }, "DisassociateManagedNotificationAccountContactResponse": { "base": null, "refs": {} }, "DisassociateManagedNotificationAdditionalChannelRequest": { "base": null, "refs": {} }, "DisassociateManagedNotificationAdditionalChannelResponse": { "base": null, "refs": {} }, "DisassociateOrganizationalUnitRequest": { "base": null, "refs": {} }, "DisassociateOrganizationalUnitResponse": { "base": null, "refs": {} }, "EnableNotificationsAccessForOrganizationRequest": { "base": null, "refs": {} }, "EnableNotificationsAccessForOrganizationResponse": { "base": null, "refs": {} }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "EventRuleArn": { "base": null, "refs": { "CreateEventRuleResponse$arn": "

The ARN of the resource.

", "DeleteEventRuleRequest$arn": "

The Amazon Resource Name (ARN) of the EventRule to delete.

", "EventRuleStructure$arn": "

The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

", "GetEventRuleRequest$arn": "

The Amazon Resource Name (ARN) of the EventRule to return.

", "GetEventRuleResponse$arn": "

The ARN of the resource.

", "UpdateEventRuleRequest$arn": "

The Amazon Resource Name (ARN) to use to update the EventRule.

", "UpdateEventRuleResponse$arn": "

The Amazon Resource Name (ARN) to use to update the EventRule.

" } }, "EventRuleEventPattern": { "base": null, "refs": { "CreateEventRuleRequest$eventPattern": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

", "EventRuleStructure$eventPattern": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

", "GetEventRuleResponse$eventPattern": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

", "UpdateEventRuleRequest$eventPattern": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

" } }, "EventRuleStatus": { "base": null, "refs": { "EventRuleStatusSummary$status": "

The status of the EventRule.

" } }, "EventRuleStatusReason": { "base": null, "refs": { "EventRuleStatusSummary$reason": "

A human-readable reason for EventRuleStatus.

" } }, "EventRuleStatusSummary": { "base": "

Provides additional information about the current EventRule status.

", "refs": { "StatusSummaryByRegion$value": null } }, "EventRuleStructure": { "base": "

Contains a complete list of fields related to an EventRule.

", "refs": { "EventRules$member": null } }, "EventRules": { "base": null, "refs": { "ListEventRulesResponse$eventRules": "

A list of EventRules.

" } }, "EventStatus": { "base": null, "refs": { "ManagedNotificationChildEvent$eventStatus": "

The assesed nature of the event.

", "ManagedNotificationChildEventSummary$eventStatus": "

The perceived nature of the event.

", "ManagedNotificationEvent$eventStatus": "

The status of an event.

", "ManagedNotificationEventSummary$eventStatus": "

The managed notification event status.

", "NotificationEvent$eventStatus": "

The assessed nature of the event.

", "NotificationEventSummary$eventStatus": "

Provides additional information about the current status of the NotificationEvent.

" } }, "EventType": { "base": null, "refs": { "CreateEventRuleRequest$eventType": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "EventRuleStructure$eventType": "

The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "GetEventRuleResponse$eventType": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

" } }, "GetEventRuleRequest": { "base": null, "refs": {} }, "GetEventRuleResponse": { "base": null, "refs": {} }, "GetManagedNotificationChildEventRequest": { "base": null, "refs": {} }, "GetManagedNotificationChildEventResponse": { "base": null, "refs": {} }, "GetManagedNotificationConfigurationRequest": { "base": null, "refs": {} }, "GetManagedNotificationConfigurationResponse": { "base": null, "refs": {} }, "GetManagedNotificationEventRequest": { "base": null, "refs": {} }, "GetManagedNotificationEventResponse": { "base": null, "refs": {} }, "GetNotificationConfigurationRequest": { "base": null, "refs": {} }, "GetNotificationConfigurationResponse": { "base": null, "refs": {} }, "GetNotificationEventRequest": { "base": null, "refs": {} }, "GetNotificationEventResponse": { "base": null, "refs": {} }, "GetNotificationsAccessForOrganizationRequest": { "base": null, "refs": {} }, "GetNotificationsAccessForOrganizationResponse": { "base": null, "refs": {} }, "Integer": { "base": null, "refs": { "AggregationSummary$eventCount": "

Indicates the number of events associated with the aggregation key.

", "SummarizationDimensionOverview$count": "

Total number of occurrences for this dimension.

", "ThrottlingException$retryAfterSeconds": "

The number of seconds a client should wait before retrying the request.

" } }, "InternalServerException": { "base": "

Unexpected error during processing of request.

", "refs": {} }, "LastActivationTime": { "base": null, "refs": { "NotificationHubOverview$lastActivationTime": "

The most recent time this NotificationHub had an ACTIVE status.

", "RegisterNotificationHubResponse$lastActivationTime": "

The date the resource was last activated.

" } }, "ListChannelsRequest": { "base": null, "refs": {} }, "ListChannelsRequestMaxResultsInteger": { "base": null, "refs": { "ListChannelsRequest$maxResults": "

The maximum number of results to be returned in this call. The default value is 20.

" } }, "ListChannelsResponse": { "base": null, "refs": {} }, "ListEventRulesRequest": { "base": null, "refs": {} }, "ListEventRulesRequestMaxResultsInteger": { "base": null, "refs": { "ListEventRulesRequest$maxResults": "

The maximum number of results to be returned in this call. The default value is 20.

" } }, "ListEventRulesResponse": { "base": null, "refs": {} }, "ListManagedNotificationChannelAssociationsRequest": { "base": null, "refs": {} }, "ListManagedNotificationChannelAssociationsRequestMaxResultsInteger": { "base": null, "refs": { "ListManagedNotificationChannelAssociationsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListManagedNotificationChannelAssociationsResponse": { "base": null, "refs": {} }, "ListManagedNotificationChildEventsRequest": { "base": null, "refs": {} }, "ListManagedNotificationChildEventsRequestMaxResultsInteger": { "base": null, "refs": { "ListManagedNotificationChildEventsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListManagedNotificationChildEventsResponse": { "base": null, "refs": {} }, "ListManagedNotificationConfigurationsRequest": { "base": null, "refs": {} }, "ListManagedNotificationConfigurationsRequestMaxResultsInteger": { "base": null, "refs": { "ListManagedNotificationConfigurationsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListManagedNotificationConfigurationsResponse": { "base": null, "refs": {} }, "ListManagedNotificationEventsRequest": { "base": null, "refs": {} }, "ListManagedNotificationEventsRequestMaxResultsInteger": { "base": null, "refs": { "ListManagedNotificationEventsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListManagedNotificationEventsResponse": { "base": null, "refs": {} }, "ListMemberAccountsRequest": { "base": null, "refs": {} }, "ListMemberAccountsRequestMaxResultsInteger": { "base": null, "refs": { "ListMemberAccountsRequest$maxResults": "

The maximum number of results to return in a single call. Valid values are 1-100.

" } }, "ListMemberAccountsResponse": { "base": null, "refs": {} }, "ListNotificationConfigurationsRequest": { "base": null, "refs": {} }, "ListNotificationConfigurationsRequestMaxResultsInteger": { "base": null, "refs": { "ListNotificationConfigurationsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListNotificationConfigurationsResponse": { "base": null, "refs": {} }, "ListNotificationEventsRequest": { "base": null, "refs": {} }, "ListNotificationEventsRequestMaxResultsInteger": { "base": null, "refs": { "ListNotificationEventsRequest$maxResults": "

The maximum number of results to be returned in this call. Defaults to 20.

" } }, "ListNotificationEventsResponse": { "base": null, "refs": {} }, "ListNotificationHubsRequest": { "base": null, "refs": {} }, "ListNotificationHubsRequestMaxResultsInteger": { "base": null, "refs": { "ListNotificationHubsRequest$maxResults": "

The maximum number of records to list in a single response.

" } }, "ListNotificationHubsResponse": { "base": null, "refs": {} }, "ListOrganizationalUnitsRequest": { "base": null, "refs": {} }, "ListOrganizationalUnitsRequestMaxResultsInteger": { "base": null, "refs": { "ListOrganizationalUnitsRequest$maxResults": "

The maximum number of organizational units to return in a single call. Valid values are 1-100.

" } }, "ListOrganizationalUnitsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "LocaleCode": { "base": null, "refs": { "GetManagedNotificationChildEventRequest$locale": "

The locale code of the language used for the retrieved ManagedNotificationChildEvent. The default locale is English en_US.

", "GetManagedNotificationEventRequest$locale": "

The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).

", "GetNotificationEventRequest$locale": "

The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.

", "ListManagedNotificationChildEventsRequest$locale": "

The locale code of the language used for the retrieved NotificationEvent. The default locale is English.en_US.

", "ListManagedNotificationEventsRequest$locale": "

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

", "ListNotificationEventsRequest$locale": "

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

", "TextByLocale$key": null } }, "ManagedNotificationChannelAssociationSummary": { "base": "

Provides a summary of channel associations for a managed notification configuration.

", "refs": { "ManagedNotificationChannelAssociations$member": null } }, "ManagedNotificationChannelAssociations": { "base": null, "refs": { "ListManagedNotificationChannelAssociationsResponse$channelAssociations": "

A list that contains the following information about a channel association.

" } }, "ManagedNotificationChildEvent": { "base": "

A ManagedNotificationChildEvent is a notification-focused representation of an event. They contain semantic information used to create aggregated or non-aggregated end-user notifications.

", "refs": { "GetManagedNotificationChildEventResponse$content": "

The content of the ManagedNotificationChildEvent.

" } }, "ManagedNotificationChildEventArn": { "base": null, "refs": { "GetManagedNotificationChildEventRequest$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent to return.

", "GetManagedNotificationChildEventResponse$arn": "

The ARN of the resource.

" } }, "ManagedNotificationChildEventOverview": { "base": "

Describes an overview and metadata for a ManagedNotificationChildEvent.

", "refs": { "ManagedNotificationChildEvents$member": null } }, "ManagedNotificationChildEventSummary": { "base": "

Describes a short summary and metadata for a ManagedNotificationChildEvent.

", "refs": { "ManagedNotificationChildEventOverview$childEvent": "

The content of the ManagedNotificationChildEvent.

" } }, "ManagedNotificationChildEvents": { "base": null, "refs": { "ListManagedNotificationChildEventsResponse$managedNotificationChildEvents": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

" } }, "ManagedNotificationConfigurationDescription": { "base": null, "refs": { "GetManagedNotificationConfigurationResponse$description": "

The description of the ManagedNotificationConfiguration.

", "ManagedNotificationConfigurationStructure$description": "

The description of the ManagedNotificationConfiguration.

" } }, "ManagedNotificationConfigurationName": { "base": null, "refs": { "GetManagedNotificationConfigurationResponse$name": "

The name of the ManagedNotificationConfiguration.

", "ManagedNotificationConfigurationStructure$name": "

The name of the ManagedNotificationConfiguration.

" } }, "ManagedNotificationConfigurationOsArn": { "base": null, "refs": { "AssociateManagedNotificationAccountContactRequest$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.

", "AssociateManagedNotificationAdditionalChannelRequest$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the additional Channel.

", "DisassociateManagedNotificationAccountContactRequest$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.

", "DisassociateManagedNotificationAdditionalChannelRequest$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel.

", "GetManagedNotificationChildEventResponse$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration associated with the ManagedNotificationChildEvent.

", "GetManagedNotificationConfigurationRequest$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to return.

", "GetManagedNotificationConfigurationResponse$arn": "

The ARN of the ManagedNotificationConfiguration resource.

", "GetManagedNotificationEventResponse$managedNotificationConfigurationArn": "

The ARN of the ManagedNotificationConfiguration.

", "ListManagedNotificationChannelAssociationsRequest$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to match.

", "ManagedNotificationChildEventOverview$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

", "ManagedNotificationConfigurationStructure$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

", "ManagedNotificationEventOverview$managedNotificationConfigurationArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

" } }, "ManagedNotificationConfigurationStructure": { "base": "

Describes the basic structure and properties of a ManagedNotificationConfiguration.

", "refs": { "ManagedNotificationConfigurations$member": null } }, "ManagedNotificationConfigurations": { "base": null, "refs": { "ListManagedNotificationConfigurationsResponse$managedNotificationConfigurations": "

A list of Managed Notification Configurations matching the request criteria.

" } }, "ManagedNotificationEvent": { "base": "

A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.

", "refs": { "GetManagedNotificationEventResponse$content": "

The content of the ManagedNotificationEvent.

" } }, "ManagedNotificationEventArn": { "base": null, "refs": { "GetManagedNotificationEventRequest$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent to return.

", "GetManagedNotificationEventResponse$arn": "

The ARN of the resource.

", "ListManagedNotificationChildEventsRequest$aggregateManagedNotificationEventArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

", "ManagedNotificationChildEvent$aggregateManagedNotificationEventArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this Managed Notification Child Event.

", "ManagedNotificationChildEventOverview$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent.

", "ManagedNotificationChildEventOverview$aggregateManagedNotificationEventArn": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this ManagedNotificationChildEvent.

", "ManagedNotificationEventOverview$arn": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

" } }, "ManagedNotificationEventOverview": { "base": "

Describes an overview and metadata for a ManagedNotificationEvent.

", "refs": { "ManagedNotificationEvents$member": null } }, "ManagedNotificationEventSummary": { "base": "

A short summary of a ManagedNotificationEvent. This is only used when listing managed notification events.

", "refs": { "ManagedNotificationEventOverview$notificationEvent": "

" } }, "ManagedNotificationEvents": { "base": null, "refs": { "ListManagedNotificationEventsResponse$managedNotificationEvents": "

A list of Managed Notification Events matching the request criteria.

" } }, "ManagedRuleArn": { "base": null, "refs": { "ManagedRuleArns$member": null } }, "ManagedRuleArns": { "base": null, "refs": { "EventRuleStructure$managedRules": "

A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

These are created by User Notifications within your account so your EventRules can function.

", "GetEventRuleResponse$managedRules": "

A list of managed rules from EventBridge that are associated with this EventRule.

These are created by User Notifications within your account so this EventRule functions.

" } }, "ManagedSourceEventMetadataSummary": { "base": "

A short summary and metadata for a managed notification event.

", "refs": { "ManagedNotificationChildEventSummary$sourceEventMetadata": "

Contains all event metadata present identically across all NotificationEvents. All fields are present in Source Events via Eventbridge.

", "ManagedNotificationEventSummary$sourceEventMetadata": "

Contains metadata about the event that caused the ManagedNotificationEvent.

" } }, "ManagedSourceEventMetadataSummaryEventOriginRegionString": { "base": null, "refs": { "ManagedSourceEventMetadataSummary$eventOriginRegion": "

The Region where the notification originated.

" } }, "ManagedSourceEventMetadataSummaryEventTypeString": { "base": null, "refs": { "ManagedSourceEventMetadataSummary$eventType": "

The event Type of the notification.

" } }, "Media": { "base": null, "refs": { "NotificationEvent$media": "

A list of media elements.

" } }, "MediaElement": { "base": "

Describes a media element.

", "refs": { "Media$member": null } }, "MediaElementType": { "base": null, "refs": { "MediaElement$type": "

The type of media.

" } }, "MediaId": { "base": null, "refs": { "MediaElement$mediaId": "

The unique ID for the media.

" } }, "MemberAccount": { "base": "

Contains information about a member account.

", "refs": { "MemberAccounts$member": null } }, "MemberAccountNotificationConfigurationStatus": { "base": null, "refs": { "ListMemberAccountsRequest$status": "

The status used to filter the member accounts.

", "MemberAccount$status": "

The current status of the member account.

" } }, "MemberAccounts": { "base": null, "refs": { "ListMemberAccountsResponse$memberAccounts": "

The list of member accounts that match the specified criteria.

" } }, "MessageComponents": { "base": "

Describes the components of a notification message.

", "refs": { "ManagedNotificationChildEvent$messageComponents": null, "ManagedNotificationEvent$messageComponents": null, "NotificationEvent$messageComponents": null } }, "MessageComponentsSummary": { "base": "

Contains the headline message component.

", "refs": { "ManagedNotificationChildEventSummary$messageComponents": null, "ManagedNotificationEventSummary$messageComponents": null, "NotificationEventSummary$messageComponents": "

The message components of a notification event.

" } }, "MessageComponentsSummaryHeadlineString": { "base": null, "refs": { "MessageComponentsSummary$headline": "

A sentence long summary. For example, titles or an email subject line.

" } }, "NextToken": { "base": null, "refs": { "ListChannelsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.

", "ListChannelsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListEventRulesRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "ListEventRulesResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListManagedNotificationChannelAssociationsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call.

", "ListManagedNotificationChannelAssociationsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListManagedNotificationChildEventsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.

", "ListManagedNotificationChildEventsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListManagedNotificationConfigurationsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.

", "ListManagedNotificationConfigurationsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListManagedNotificationEventsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.

", "ListManagedNotificationEventsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListMemberAccountsRequest$nextToken": "

The token for the next page of results. Use the value returned in the previous response.

", "ListMemberAccountsResponse$nextToken": "

The token to use for the next page of results.

", "ListNotificationConfigurationsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "ListNotificationConfigurationsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListNotificationEventsRequest$nextToken": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "ListNotificationEventsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListNotificationHubsRequest$nextToken": "

A pagination token. Set to null to start listing notification hubs from the start.

", "ListNotificationHubsResponse$nextToken": "

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

", "ListOrganizationalUnitsRequest$nextToken": "

The token for the next page of results. Use the value returned in the previous response.

", "ListOrganizationalUnitsResponse$nextToken": "

The token to use for the next page of results. If there are no additional results, this value is null.

" } }, "NotificationConfigurationArn": { "base": null, "refs": { "AssociateChannelRequest$notificationConfigurationArn": "

The ARN of the NotificationConfiguration to associate with the Channel.

", "AssociateOrganizationalUnitRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the notification configuration to associate with the organizational unit.

", "CreateEventRuleRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.

", "CreateEventRuleResponse$notificationConfigurationArn": "

The ARN of a NotificationConfiguration.

", "CreateNotificationConfigurationResponse$arn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "DeleteNotificationConfigurationRequest$arn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.

", "DisassociateChannelRequest$notificationConfigurationArn": "

The ARN of the NotificationConfiguration to disassociate.

", "DisassociateOrganizationalUnitRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the notification configuration to disassociate from the organizational unit.

", "EventRuleStructure$notificationConfigurationArn": "

The ARN for the NotificationConfiguration associated with this EventRule.

", "GetEventRuleResponse$notificationConfigurationArn": "

The ARN of a NotificationConfiguration.

", "GetNotificationConfigurationRequest$arn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration to return.

", "GetNotificationConfigurationResponse$arn": "

The ARN of the resource.

", "GetNotificationEventResponse$notificationConfigurationArn": "

The ARN of the NotificationConfiguration.

", "ListChannelsRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "ListEventRulesRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "ListMemberAccountsRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the notification configuration used to filter the member accounts.

", "ListOrganizationalUnitsRequest$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the notification configuration used to filter the organizational units.

", "ListTagsForResourceRequest$arn": "

The Amazon Resource Name (ARN) to use to list tags.

", "MemberAccount$notificationConfigurationArn": "

The Amazon Resource Name (ARN) of the notification configuration associated with the member account.

", "NotificationConfigurationStructure$arn": "

The Amazon Resource Name (ARN) of the NotificationConfiguration resource.

", "NotificationEventOverview$notificationConfigurationArn": "

The ARN of the NotificationConfiguration.

", "TagResourceRequest$arn": "

The Amazon Resource Name (ARN) to use to tag a resource.

", "UntagResourceRequest$arn": "

The Amazon Resource Name (ARN) to use to untag a resource.

", "UpdateEventRuleResponse$notificationConfigurationArn": "

The ARN of the NotificationConfiguration.

", "UpdateNotificationConfigurationRequest$arn": "

The Amazon Resource Name (ARN) used to update the NotificationConfiguration.

", "UpdateNotificationConfigurationResponse$arn": "

The ARN used to update the NotificationConfiguration.

" } }, "NotificationConfigurationDescription": { "base": null, "refs": { "CreateNotificationConfigurationRequest$description": "

The description of the NotificationConfiguration.

", "GetNotificationConfigurationResponse$description": "

The description of the NotificationConfiguration.

", "NotificationConfigurationStructure$description": "

The description of the NotificationConfiguration.

", "UpdateNotificationConfigurationRequest$description": "

The description of the NotificationConfiguration.

" } }, "NotificationConfigurationName": { "base": null, "refs": { "CreateNotificationConfigurationRequest$name": "

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

", "GetNotificationConfigurationResponse$name": "

The name of the NotificationConfiguration.

", "NotificationConfigurationStructure$name": "

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

", "UpdateNotificationConfigurationRequest$name": "

The name of the NotificationConfiguration.

" } }, "NotificationConfigurationStatus": { "base": null, "refs": { "CreateNotificationConfigurationResponse$status": "

The current status of this NotificationConfiguration.

", "GetNotificationConfigurationResponse$status": "

The status of this NotificationConfiguration.

", "ListNotificationConfigurationsRequest$status": "

The NotificationConfiguration status to match.

", "NotificationConfigurationStructure$status": "

The current status of the NotificationConfiguration.

" } }, "NotificationConfigurationStructure": { "base": "

Contains the complete list of fields for a NotificationConfiguration.

", "refs": { "NotificationConfigurations$member": null } }, "NotificationConfigurationSubtype": { "base": null, "refs": { "GetNotificationConfigurationResponse$subtype": "

The subtype of the notification configuration returned in the response.

", "ListNotificationConfigurationsRequest$subtype": "

The subtype used to filter the notification configurations in the request.

", "NotificationConfigurationStructure$subtype": "

The subtype of the notification configuration.

" } }, "NotificationConfigurations": { "base": null, "refs": { "ListNotificationConfigurationsResponse$notificationConfigurations": "

The NotificationConfigurations in the account.

" } }, "NotificationEvent": { "base": "

A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.

", "refs": { "GetNotificationEventResponse$content": "

The content of the NotificationEvent.

" } }, "NotificationEventArn": { "base": null, "refs": { "GetNotificationEventRequest$arn": "

The Amazon Resource Name (ARN) of the NotificationEvent to return.

", "GetNotificationEventResponse$arn": "

The ARN of the resource.

", "ListNotificationEventsRequest$aggregateNotificationEventArn": "

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.

", "NotificationEvent$aggregateNotificationEventArn": "

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

", "NotificationEventOverview$arn": "

The Amazon Resource Name (ARN) of the resource.

", "NotificationEventOverview$aggregateNotificationEventArn": "

The ARN of the aggregatedNotificationEventArn to match.

" } }, "NotificationEventId": { "base": null, "refs": { "ManagedNotificationChildEvent$id": "

The unique identifier for a Managed Notification Child Event.

", "ManagedNotificationEvent$id": "

Unique identifier for a ManagedNotificationEvent.

", "NotificationEvent$id": "

The unique identifier for a NotificationEvent.

" } }, "NotificationEventOverview": { "base": "

Describes a short summary of a NotificationEvent. This is only used when listing notification events.

", "refs": { "NotificationEvents$member": null } }, "NotificationEventSummary": { "base": "

Describes a short summary and metadata for a NotificationEvent.

", "refs": { "NotificationEventOverview$notificationEvent": "

Refers to a NotificationEventSummary object.

Similar in structure to content in the GetNotificationEvent response.

" } }, "NotificationEvents": { "base": null, "refs": { "ListNotificationEventsResponse$notificationEvents": "

The list of notification events.

" } }, "NotificationHubOverview": { "base": "

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.

", "refs": { "NotificationHubs$member": null } }, "NotificationHubStatus": { "base": null, "refs": { "NotificationHubStatusSummary$status": "

Status information about the NotificationHub.

" } }, "NotificationHubStatusReason": { "base": null, "refs": { "NotificationHubStatusSummary$reason": "

An explanation for the current status.

" } }, "NotificationHubStatusSummary": { "base": "

Provides additional information about the current NotificationHub status.

", "refs": { "DeregisterNotificationHubResponse$statusSummary": "

NotificationConfiguration status information.

", "NotificationHubOverview$statusSummary": "

The status summary of the resource.

", "RegisterNotificationHubResponse$statusSummary": "

Provides additional information about the current NotificationConfiguration status information.

" } }, "NotificationHubs": { "base": null, "refs": { "ListNotificationHubsResponse$notificationHubs": "

The NotificationHubs in the account.

" } }, "NotificationType": { "base": null, "refs": { "ManagedNotificationChildEvent$notificationType": "

The type of event causing the notification.

", "ManagedNotificationChildEventSummary$notificationType": "

The Type of the event causing this notification.

", "ManagedNotificationEvent$notificationType": "

The nature of the event causing this notification.

", "ManagedNotificationEventSummary$notificationType": "

The Type of event causing the notification.

", "NotificationEvent$notificationType": "

The type of event causing the notification.

", "NotificationEventSummary$notificationType": "

The type of event causing the notification.

" } }, "NotificationsAccessForOrganization": { "base": "

Orgs Service trust for User Notifications.

", "refs": { "GetNotificationsAccessForOrganizationResponse$notificationsAccessForOrganization": "

The AccessStatus of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.

" } }, "OrganizationalUnitId": { "base": null, "refs": { "AssociateOrganizationalUnitRequest$organizationalUnitId": "

The unique identifier of the organizational unit to associate.

", "DisassociateOrganizationalUnitRequest$organizationalUnitId": "

The unique identifier of the organizational unit to disassociate.

", "ListManagedNotificationChildEventsRequest$organizationalUnitId": "

The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.

", "ListManagedNotificationEventsRequest$organizationalUnitId": "

The Organizational Unit Id that an Amazon Web Services account belongs to.

", "ListMemberAccountsRequest$organizationalUnitId": "

The organizational unit ID used to filter the member accounts.

", "ListNotificationEventsRequest$organizationalUnitId": "

The unique identifier of the organizational unit used to filter notification events.

", "ManagedNotificationChildEvent$organizationalUnitId": "

The Organizational Unit Id that an Amazon Web Services account belongs to.

", "ManagedNotificationChildEventOverview$organizationalUnitId": "

The Organizational Unit Id that an AWS account belongs to.

", "ManagedNotificationEvent$organizationalUnitId": "

The Organizational Unit Id that an Amazon Web Services account belongs to.

", "ManagedNotificationEventOverview$organizationalUnitId": "

The Organizational Unit Id that an Amazon Web Services account belongs to.

", "MemberAccount$organizationalUnitId": "

The unique identifier of the organizational unit containing the member account.

", "NotificationEvent$organizationalUnitId": "

The unique identifier of the organizational unit associated with the notification event.

", "NotificationEventOverview$organizationalUnitId": "

The unique identifier of the organizational unit in the notification event overview.

", "OrganizationalUnits$member": null } }, "OrganizationalUnits": { "base": null, "refs": { "ListOrganizationalUnitsResponse$organizationalUnits": "

The list of organizational units that match the specified criteria.

" } }, "QuotaCode": { "base": null, "refs": { "ServiceQuotaExceededException$quotaCode": "

The code for the service quota in Service Quotas.

", "ThrottlingException$quotaCode": "

Identifies the quota that is being throttled.

" } }, "Region": { "base": null, "refs": { "AggregatedNotificationRegions$member": null, "DeregisterNotificationHubRequest$notificationHubRegion": "

The NotificationConfiguration Region.

", "DeregisterNotificationHubResponse$notificationHubRegion": "

The NotificationConfiguration Region.

", "NotificationHubOverview$notificationHubRegion": "

The Region of the resource.

", "Regions$member": null, "RegisterNotificationHubRequest$notificationHubRegion": "

The Region of the NotificationHub.

", "RegisterNotificationHubResponse$notificationHubRegion": "

The Region of the NotificationHub.

", "StatusSummaryByRegion$key": null } }, "Regions": { "base": null, "refs": { "CreateEventRuleRequest$regions": "

A list of Amazon Web Services Regions that send events to this EventRule.

", "EventRuleStructure$regions": "

A list of Amazon Web Services Regions that send events to this EventRule.

", "GetEventRuleResponse$regions": "

A list of Amazon Web Services Regions that send events to this EventRule.

", "UpdateEventRuleRequest$regions": "

A list of Amazon Web Services Regions that sends events to this EventRule.

" } }, "RegisterNotificationHubRequest": { "base": null, "refs": {} }, "RegisterNotificationHubResponse": { "base": null, "refs": {} }, "Resource": { "base": "

A resource affected by or closely linked to an event.

", "refs": { "Resources$member": null } }, "ResourceId": { "base": null, "refs": { "ConflictException$resourceId": "

The resource ID that prompted the conflict error.

", "ResourceNotFoundException$resourceId": "

The ID of the resource that wasn't found.

", "ServiceQuotaExceededException$resourceId": "

The ID of the resource that exceeds the service quota.

" } }, "ResourceNotFoundException": { "base": "

Request references a resource which does not exist.

", "refs": {} }, "ResourceType": { "base": null, "refs": { "ServiceQuotaExceededException$resourceType": "

The type of the resource that exceeds the service quota.

" } }, "Resources": { "base": null, "refs": { "SourceEventMetadata$relatedResources": "

A list of resources related to this NotificationEvent.

" } }, "SampleAggregationDimensionValues": { "base": null, "refs": { "SummarizationDimensionOverview$sampleValues": "

Indicates the sample values found within the dimension.

" } }, "SampleAggregationDimensionValuesMemberString": { "base": null, "refs": { "SampleAggregationDimensionValues$member": null } }, "SchemaVersion": { "base": null, "refs": { "ManagedNotificationChildEvent$schemaVersion": "

The schema version of the Managed Notification Child Event.

", "ManagedNotificationChildEventSummary$schemaVersion": "

The schema version of the ManagedNotificationChildEvent.

", "ManagedNotificationEvent$schemaVersion": "

Version of the ManagedNotificationEvent schema.

", "ManagedNotificationEventSummary$schemaVersion": "

The schema version of the ManagedNotificationEvent.

", "NotificationEvent$schemaVersion": "

The schema version of the Notification Event.

", "NotificationEventSummary$schemaVersion": "

The schema version of the Notification Event.

" } }, "ServiceCode": { "base": null, "refs": { "ServiceQuotaExceededException$serviceCode": "

The code for the service quota exceeded in Service Quotas.

", "ThrottlingException$serviceCode": "

Identifies the service being throttled.

" } }, "ServiceQuotaExceededException": { "base": "

Request would cause a service quota to be exceeded.

", "refs": {} }, "Source": { "base": null, "refs": { "CreateEventRuleRequest$source": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "EventRuleStructure$source": "

The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "GetEventRuleResponse$source": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "ListManagedNotificationEventsRequest$source": "

The Amazon Web Services service the event originates from. For example aws.cloudwatch.

", "ListNotificationConfigurationsRequest$eventRuleSource": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "ListNotificationEventsRequest$source": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "ManagedSourceEventMetadataSummary$source": "

The source service of the notification.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "SourceEventMetadata$source": "

The Amazon Web Services service the event originates from. For example aws.cloudwatch.

" } }, "SourceEventMetadata": { "base": "

Describes the metadata for a source event.

For more information, see Event structure reference in the Amazon EventBridge User Guide.

", "refs": { "NotificationEvent$sourceEventMetadata": "

The source event metadata.

" } }, "SourceEventMetadataEventOriginRegionString": { "base": null, "refs": { "SourceEventMetadata$eventOriginRegion": "

The Region the event originated from.

" } }, "SourceEventMetadataEventTypeString": { "base": null, "refs": { "SourceEventMetadata$eventType": "

The type of event. For example, an Amazon CloudWatch state change.

" } }, "SourceEventMetadataEventTypeVersionString": { "base": null, "refs": { "SourceEventMetadata$eventTypeVersion": "

The version of the type of event.

" } }, "SourceEventMetadataRelatedAccountString": { "base": null, "refs": { "SourceEventMetadata$relatedAccount": "

The primary Amazon Web Services account of SourceEvent.

" } }, "SourceEventMetadataSummary": { "base": "

Contains metadata about the event that caused the NotificationEvent. For other specific values, see sourceEventMetadata.

", "refs": { "NotificationEventSummary$sourceEventMetadata": "

The source event metadata.

" } }, "SourceEventMetadataSummaryEventOriginRegionString": { "base": null, "refs": { "SourceEventMetadataSummary$eventOriginRegion": "

The Region where the notification originated.

Unavailable for aggregated notifications.

" } }, "SourceEventMetadataSummaryEventTypeString": { "base": null, "refs": { "SourceEventMetadataSummary$eventType": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

" } }, "StatusSummaryByRegion": { "base": null, "refs": { "CreateEventRuleResponse$statusSummaryByRegion": "

A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.

", "EventRuleStructure$statusSummaryByRegion": "

A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.

", "GetEventRuleResponse$statusSummaryByRegion": "

A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.

", "UpdateEventRuleResponse$statusSummaryByRegion": "

The status of the action by Region.

" } }, "String": { "base": null, "refs": { "AggregationKey$name": "

Indicates the type of aggregation key.

", "AggregationKey$value": "

Indicates the value associated with the aggregation key name.

", "GetManagedNotificationConfigurationResponse$category": "

The category of the ManagedNotificationConfiguration.

", "GetManagedNotificationConfigurationResponse$subCategory": "

The subCategory of the ManagedNotificationConfiguration.

", "ManagedNotificationChannelAssociationSummary$channelIdentifier": "

The unique identifier for the notification channel.

", "ManagedNotificationChildEvent$sourceEventDetailUrlDisplayText": "

The detailed URL for the source event.

", "ManagedNotificationEvent$sourceEventDetailUrlDisplayText": "

Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.

", "MemberAccount$statusReason": "

The reason for the current status of the member account.

", "NotificationEvent$sourceEventDetailUrlDisplayText": "

The detailed URL for the source event.

", "Resource$id": "

The unique identifier for the resource.

At least one id or ARN is required.

", "SourceEventMetadata$sourceEventId": "

The source event id.

", "SourceEventMetadataSummary$source": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "SummarizationDimensionDetail$name": "

The name of the SummarizationDimensionDetail.

", "SummarizationDimensionDetail$value": "

Value of the property used to summarize aggregated events.

", "SummarizationDimensionOverview$name": "

Name of the summarization dimension.

", "TextByLocale$value": null, "ValidationExceptionField$name": "

The field name where the invalid entry was detected.

", "ValidationExceptionField$message": "

A message with the reason for the validation exception error.

" } }, "SummarizationDimensionDetail": { "base": "

Provides detailed information about the dimensions used for event summarization and aggregation.

", "refs": { "SummarizationDimensionDetails$member": null } }, "SummarizationDimensionDetails": { "base": null, "refs": { "AggregationDetail$summarizationDimensions": "

Properties used to summarize aggregated events.

" } }, "SummarizationDimensionOverview": { "base": "

Provides an overview of how data is summarized across different dimensions.

", "refs": { "AggregationSummary$aggregatedAccounts": "

Indicates the Amazon Web Services accounts in the aggregation key.

", "AggregationSummary$aggregatedRegions": "

Indicates the Amazon Web Services Regions in the aggregation key.

", "AggregationSummary$aggregatedOrganizationalUnits": "

Indicates the collection of organizational units that are involved in the aggregation key.

", "SummarizationDimensionOverviews$member": null } }, "SummarizationDimensionOverviews": { "base": null, "refs": { "AggregationSummary$additionalSummarizationDimensions": "

List of additional dimensions used to group and summarize data.

" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "ListManagedNotificationChildEventsRequest$startTime": "

The earliest time of events to return from this call.

", "ListManagedNotificationChildEventsRequest$endTime": "

Latest time of events to return from this call.

", "ListManagedNotificationEventsRequest$startTime": "

The earliest time of events to return from this call.

", "ListManagedNotificationEventsRequest$endTime": "

Latest time of events to return from this call.

", "ListNotificationEventsRequest$startTime": "

The earliest time of events to return from this call.

", "ListNotificationEventsRequest$endTime": "

Latest time of events to return from this call.

", "ManagedNotificationChildEvent$startTime": "

The notification event start time.

", "ManagedNotificationChildEvent$endTime": "

The end time of the event.

", "ManagedNotificationEvent$startTime": "

The earliest time of events to return from this call.

", "ManagedNotificationEvent$endTime": "

The end time of the notification event.

", "NotificationEvent$startTime": "

The notification event start time.

", "NotificationEvent$endTime": "

The end time of the event.

", "SourceEventMetadata$eventOccurrenceTime": "

The date and time the source event occurred. This is based on the Source Event.

" } }, "TagKey": { "base": null, "refs": { "TagKeys$member": null, "TagMap$key": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "

The tag keys to use to untag a resource.

" } }, "TagMap": { "base": null, "refs": { "CreateNotificationConfigurationRequest$tags": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

", "ListTagsForResourceResponse$tags": "

A list of tags for the specified ARN.

", "TagResourceRequest$tags": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "Tags": { "base": null, "refs": { "Resource$tags": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

" } }, "TagsMemberString": { "base": null, "refs": { "Tags$member": null } }, "TextByLocale": { "base": null, "refs": { "TextPartValue$textByLocale": "

A map of locales to the text in that locale.

" } }, "TextPartId": { "base": null, "refs": { "TextParts$key": null } }, "TextPartReference": { "base": null, "refs": { "Dimension$name": "

The name of the dimension

", "Dimension$value": "

The value of the dimension.

", "MediaElement$caption": "

The caption of the media.

", "MessageComponents$headline": "

A sentence long summary. For example, titles or an email subject line.

", "MessageComponents$paragraphSummary": "

A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.

", "MessageComponents$completeDescription": "

A complete summary with all possible relevant information.

" } }, "TextPartType": { "base": null, "refs": { "TextPartValue$type": "

The type of text part. Determines the usage of all other fields and whether or not they're required.

" } }, "TextPartValue": { "base": "

Describes text information objects containing fields that determine how text part objects are composed.

", "refs": { "TextParts$value": null } }, "TextPartValueDisplayTextString": { "base": null, "refs": { "TextPartValue$displayText": "

A short single line description of the link. Must be hyper-linked with the URL itself.

Used for text parts with the type URL.

" } }, "TextParts": { "base": null, "refs": { "ManagedNotificationChildEvent$textParts": "

A list of text values.

", "ManagedNotificationEvent$textParts": "

A list of text values.

", "NotificationEvent$textParts": "

A list of text values.

" } }, "ThrottlingException": { "base": "

Request was denied due to request throttling.

", "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateEventRuleRequest": { "base": null, "refs": {} }, "UpdateEventRuleResponse": { "base": null, "refs": {} }, "UpdateNotificationConfigurationRequest": { "base": null, "refs": {} }, "UpdateNotificationConfigurationResponse": { "base": null, "refs": {} }, "Url": { "base": null, "refs": { "ManagedNotificationChildEvent$sourceEventDetailUrl": "

The source event URL.

", "ManagedNotificationEvent$sourceEventDetailUrl": "

URL defined by Source Service to be used by notification consumers to get additional information about event.

", "MediaElement$url": "

The URL of the media.

", "NotificationEvent$sourceEventDetailUrl": "

The source event URL.

", "Resource$detailUrl": "

The URL to the resource's detail page. If a detail page URL is unavailable, it is the URL to an informational page that describes the resource's type.

", "TextPartValue$url": "

The URL itself.

" } }, "ValidationException": { "base": "

This exception is thrown when the notification event fails validation.

", "refs": {} }, "ValidationExceptionField": { "base": "

Stores information about a field passed inside a request that resulted in an exception.

", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "

The list of input fields that are invalid.

" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "

The reason why your input is considered invalid.

" } } } }