{ "smithy": "2.0", "shapes": { "com.amazonaws.notifications#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.notifications#AccessStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.notifications#AccountContactType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACCOUNT_PRIMARY", "value": "ACCOUNT_PRIMARY", "documentation": " Primary Contact managed by AWS Account Management Service.\n" }, { "name": "ACCOUNT_ALTERNATE_BILLING", "value": "ACCOUNT_ALTERNATE_BILLING", "documentation": " Alternate Billing Contact managed by AWS Account Management Service.\n" }, { "name": "ACCOUNT_ALTERNATE_OPERATIONS", "value": "ACCOUNT_ALTERNATE_OPERATIONS", "documentation": " Alternate Operations Contact managed by AWS Account Management Service.\n" }, { "name": "ACCOUNT_ALTERNATE_SECURITY", "value": "ACCOUNT_ALTERNATE_SECURITY", "documentation": " Alternate Security Contact managed by AWS Account Management Service.\n" } ] } }, "com.amazonaws.notifications#AccountId": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.notifications#AggregatedNotificationRegions": { "type": "list", "member": { "target": "com.amazonaws.notifications#Region" } }, "com.amazonaws.notifications#AggregationDetail": { "type": "structure", "members": { "summarizationDimensions": { "target": "com.amazonaws.notifications#SummarizationDimensionDetails", "traits": { "smithy.api#documentation": "

Properties used to summarize aggregated events.

" } } }, "traits": { "smithy.api#documentation": "

Provides detailed information about the dimensions used for aggregation.

" } }, "com.amazonaws.notifications#AggregationDuration": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "LONG", "value": "LONG", "documentation": "Aggregate notifications for long periods of time (12 hours)" }, { "name": "SHORT", "value": "SHORT", "documentation": "Aggregate notifications for short periods of time (5 mins)" }, { "name": "NONE", "value": "NONE", "documentation": "Do not aggregate notifications sourced from a notification configuration" } ] } }, "com.amazonaws.notifications#AggregationEventType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "AGGREGATE", "value": "AGGREGATE" }, { "name": "CHILD", "value": "CHILD" }, { "name": "NONE", "value": "NONE" } ] } }, "com.amazonaws.notifications#AggregationKey": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Indicates the type of aggregation key.

", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Indicates the value associated with the aggregation key name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Key-value collection that indicate how notifications are grouped.

" } }, "com.amazonaws.notifications#AggregationKeys": { "type": "list", "member": { "target": "com.amazonaws.notifications#AggregationKey" } }, "com.amazonaws.notifications#AggregationSummary": { "type": "structure", "members": { "eventCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Indicates the number of events associated with the aggregation key.

", "smithy.api#required": {} } }, "aggregatedBy": { "target": "com.amazonaws.notifications#AggregationKeys", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "aggregatedAccounts": { "target": "com.amazonaws.notifications#SummarizationDimensionOverview", "traits": { "smithy.api#documentation": "

Indicates the Amazon Web Services accounts in the aggregation key.

", "smithy.api#required": {} } }, "aggregatedRegions": { "target": "com.amazonaws.notifications#SummarizationDimensionOverview", "traits": { "smithy.api#documentation": "

Indicates the Amazon Web Services Regions in the aggregation key.

", "smithy.api#required": {} } }, "aggregatedOrganizationalUnits": { "target": "com.amazonaws.notifications#SummarizationDimensionOverview", "traits": { "smithy.api#documentation": "

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

" } }, "additionalSummarizationDimensions": { "target": "com.amazonaws.notifications#SummarizationDimensionOverviews", "traits": { "smithy.api#documentation": "

List of additional dimensions used to group and summarize data.

" } } }, "traits": { "smithy.api#documentation": "

Provides additional information about the aggregation key.

" } }, "com.amazonaws.notifications#Arn": { "type": "string", "traits": { "aws.api#arnReference": {}, "smithy.api#pattern": "^arn:[^:]*:[^:]*:[^:]*:.*$" } }, "com.amazonaws.notifications#AssociateChannel": { "type": "operation", "input": { "target": "com.amazonaws.notifications#AssociateChannelRequest" }, "output": { "target": "com.amazonaws.notifications#AssociateChannelResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to associate a new Channel with a particular NotificationConfiguration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/channels/associate/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#AssociateChannelRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the NotificationConfiguration to associate with the Channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#AssociateChannelResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAccountContact": { "type": "operation", "input": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAccountContactRequest" }, "output": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAccountContactResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to associate an Account contact\n to a particular Managed Notification Configuration" }, "smithy.api#documentation": "

Associates an Account Contact with a particular ManagedNotificationConfiguration.

", "smithy.api#http": { "code": 201, "method": "PUT", "uri": "/contacts/associate-managed-notification/{contactIdentifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAccountContactRequest": { "type": "structure", "members": { "contactIdentifier": { "target": "com.amazonaws.notifications#AccountContactType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "isSensitiveEventsSubscribed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether this contact is subscribed to sensitive events. The notifications:SubscribeSensitiveEvents permission controls access to sensitive events. Defaults to false.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAccountContactResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannel": { "type": "operation", "input": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannelRequest" }, "output": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannelResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to associate a Channel\n to a particular Managed Notification Configuration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 201, "method": "PUT", "uri": "/channels/associate-managed-notification/{channelArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannelRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "isSensitiveEventsSubscribed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether this channel is subscribed to sensitive events. The notifications:SubscribeSensitiveEvents permission controls access to sensitive events. Defaults to false.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannelResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#AssociateOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.notifications#AssociateOrganizationalUnitRequest" }, "output": { "target": "com.amazonaws.notifications#AssociateOrganizationalUnitResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to associate an Organizational Unit with a particular NotificationConfiguration" }, "smithy.api#documentation": "

Associates an organizational unit with a notification configuration.

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/organizational-units/associate/{organizationalUnitId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#AssociateOrganizationalUnitRequest": { "type": "structure", "members": { "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The unique identifier of the organizational unit to associate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#AssociateOrganizationalUnitResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#AttachmentContentType": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9]+/[a-zA-Z0-9][a-zA-Z0-9!#$&\\-^_.+]*$" } }, "com.amazonaws.notifications#AttachmentDisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.notifications#Channel": { "type": "resource", "identifiers": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn" }, "arn": { "target": "com.amazonaws.notifications#ChannelArn" } }, "put": { "target": "com.amazonaws.notifications#AssociateChannel" }, "delete": { "target": "com.amazonaws.notifications#DisassociateChannel" }, "list": { "target": "com.amazonaws.notifications#ListChannels" }, "traits": { "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#ChannelArn": { "type": "string", "traits": { "aws.api#arnReference": {}, "smithy.api#pattern": "^arn:[a-z-]{3,10}:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$" } }, "com.amazonaws.notifications#ChannelAssociationOverrideOption": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ENABLED", "value": "ENABLED", "documentation": " AWS User Notification service users can associate or disassociate a Channel with a notification configuration.\n" }, { "name": "DISABLED", "value": "DISABLED", "documentation": " AWS User Notification service users can not associate or disassociate a Channel with a notification configuration.\n" } ] } }, "com.amazonaws.notifications#ChannelIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^(ACCOUNT_PRIMARY|ACCOUNT_ALTERNATE_BILLING|ACCOUNT_ALTERNATE_OPERATIONS|ACCOUNT_ALTERNATE_SECURITY|arn:[a-z-]{3,10}:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+)$" } }, "com.amazonaws.notifications#ChannelType": { "type": "enum", "members": { "MOBILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "AWS Console Mobile App sends notifications to mobile devices. Link:https://aws.amazon.com/console/mobile/", "smithy.api#enumValue": "MOBILE" } }, "CHATBOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Chatbot sends notifications to group platforms, like Slack or Chime. Link:https://aws.amazon.com/chatbot/", "smithy.api#enumValue": "CHATBOT" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Email sends notifications to email addresses.", "smithy.api#enumValue": "EMAIL" } }, "ACCOUNT_CONTACT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "User Notification Service sends notifications to Account Managed contacts.", "smithy.api#enumValue": "ACCOUNT_CONTACT" } } } }, "com.amazonaws.notifications#Channels": { "type": "list", "member": { "target": "com.amazonaws.notifications#ChannelArn" } }, "com.amazonaws.notifications#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.notifications#ResourceId", "traits": { "smithy.api#documentation": "

The resource ID that prompted the conflict error.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.notifications#CreateEventRule": { "type": "operation", "input": { "target": "com.amazonaws.notifications#CreateEventRuleRequest" }, "output": { "target": "com.amazonaws.notifications#CreateEventRuleResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to create a new EventRule, associating it with a NotificationConfiguration" }, "smithy.api#documentation": "

Creates an EventRule that is associated with a specified NotificationConfiguration.

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/event-rules" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#CreateEventRuleRequest": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { "smithy.api#documentation": "

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.

" } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#CreateEventRuleResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of a NotificationConfiguration.

", "smithy.api#required": {} } }, "statusSummaryByRegion": { "target": "com.amazonaws.notifications#StatusSummaryByRegion", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#CreateNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.notifications#CreateNotificationConfigurationRequest" }, "output": { "target": "com.amazonaws.notifications#CreateNotificationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to create a NotificationConfiguration" }, "smithy.api#documentation": "

Creates a new NotificationConfiguration.

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/notification-configurations" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#CreateNotificationConfigurationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.notifications#NotificationConfigurationName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.notifications#NotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the NotificationConfiguration.

", "smithy.api#required": {} } }, "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

" } }, "tags": { "target": "com.amazonaws.notifications#TagMap", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#CreateNotificationConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.notifications#NotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The current status of this NotificationConfiguration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#CreationTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.notifications#DeleteEventRule": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DeleteEventRuleRequest" }, "output": { "target": "com.amazonaws.notifications#DeleteEventRuleResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to delete an EventRule" }, "smithy.api#documentation": "

Deletes an EventRule.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/event-rules/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DeleteEventRuleRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DeleteEventRuleResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DeleteNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DeleteNotificationConfigurationRequest" }, "output": { "target": "com.amazonaws.notifications#DeleteNotificationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to delete a NotificationConfiguration" }, "smithy.api#documentation": "

Deletes a NotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/notification-configurations/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DeleteNotificationConfigurationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DeleteNotificationConfigurationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DeregisterNotificationHub": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DeregisterNotificationHubRequest" }, "output": { "target": "com.amazonaws.notifications#DeregisterNotificationHubResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to deregister a NotificationHub" }, "smithy.api#documentation": "

Deregisters a NotificationHub in the specified Region.

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

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/notification-hubs/{notificationHubRegion}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DeregisterNotificationHubRequest": { "type": "structure", "members": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The NotificationHub Region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DeregisterNotificationHubResponse": { "type": "structure", "members": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The NotificationHub Region.

", "smithy.api#required": {} } }, "statusSummary": { "target": "com.amazonaws.notifications#NotificationHubStatusSummary", "traits": { "smithy.api#documentation": "

NotificationHub status information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#Dimension": { "type": "structure", "members": { "name": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

The name of the dimension

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

The value of the dimension.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The key-value pair of properties for an event.

" } }, "com.amazonaws.notifications#Dimensions": { "type": "list", "member": { "target": "com.amazonaws.notifications#Dimension" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.notifications#DisableNotificationsAccessForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DisableNotificationsAccessForOrganizationRequest" }, "output": { "target": "com.amazonaws.notifications#DisableNotificationsAccessForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to disable Service Trust for AWS User Notifications", "requiredActions": [ "organizations:DisableAWSServiceAccess" ] }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/organization/access" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DisableNotificationsAccessForOrganizationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DisableNotificationsAccessForOrganizationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DisassociateChannel": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DisassociateChannelRequest" }, "output": { "target": "com.amazonaws.notifications#DisassociateChannelResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to remove a Channel from a NotificationConfiguration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/channels/disassociate/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DisassociateChannelRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the NotificationConfiguration to disassociate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DisassociateChannelResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAccountContact": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAccountContactRequest" }, "output": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAccountContactResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to remove an Account contact from a Managed Notification Configuration" }, "smithy.api#documentation": "

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/contacts/disassociate-managed-notification/{contactIdentifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAccountContactRequest": { "type": "structure", "members": { "contactIdentifier": { "target": "com.amazonaws.notifications#AccountContactType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAccountContactResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannel": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannelRequest" }, "output": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannelResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to remove a Channel from a Managed Notification Configuration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/channels/disassociate-managed-notification/{channelArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannelRequest": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannelResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#DisassociateOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.notifications#DisassociateOrganizationalUnitRequest" }, "output": { "target": "com.amazonaws.notifications#DisassociateOrganizationalUnitResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to remove an Organizational Unit from a NotificationConfiguration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/organizational-units/disassociate/{organizationalUnitId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#DisassociateOrganizationalUnitRequest": { "type": "structure", "members": { "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The unique identifier of the organizational unit to disassociate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#DisassociateOrganizationalUnitResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#EnableNotificationsAccessForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.notifications#EnableNotificationsAccessForOrganizationRequest" }, "output": { "target": "com.amazonaws.notifications#EnableNotificationsAccessForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to enable Service Trust for AWS User Notifications", "requiredActions": [ "organizations:EnableAWSServiceAccess", "iam:CreateServiceLinkedRole" ] }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/organization/access" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#EnableNotificationsAccessForOrganizationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#EnableNotificationsAccessForOrganizationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ErrorMessage": { "type": "string" }, "com.amazonaws.notifications#EventRule": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn" } }, "put": { "target": "com.amazonaws.notifications#UpdateEventRule" }, "create": { "target": "com.amazonaws.notifications#CreateEventRule" }, "read": { "target": "com.amazonaws.notifications#GetEventRule" }, "delete": { "target": "com.amazonaws.notifications#DeleteEventRule" }, "list": { "target": "com.amazonaws.notifications#ListEventRules" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true }, "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#EventRuleArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.notifications#Notifications", "resource": "com.amazonaws.notifications#EventRule" }, "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications::[0-9]{12}:configuration/[a-z0-9]{27}/rule/[a-z0-9]{27}$" } }, "com.amazonaws.notifications#EventRuleEventPattern": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.notifications#EventRuleStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "ACTIVE", "documentation": "EventRule is processing events. Any call can be executed." }, { "name": "INACTIVE", "value": "INACTIVE", "documentation": "EventRule is in a bad state and may not be processing events. Any call can be executed." }, { "name": "CREATING", "value": "CREATING", "documentation": "This EventRule is being created. Only GET/LIST calls can be executed." }, { "name": "UPDATING", "value": "UPDATING", "documentation": "This EventRule is being updated. Only GET/LIST calls can be executed." }, { "name": "DELETING", "value": "DELETING", "documentation": "This EventRule is being deleted. Only GET/LIST calls can be executed." } ] } }, "com.amazonaws.notifications#EventRuleStatusReason": { "type": "string" }, "com.amazonaws.notifications#EventRuleStatusSummary": { "type": "structure", "members": { "status": { "target": "com.amazonaws.notifications#EventRuleStatus", "traits": { "smithy.api#documentation": "

The status of the EventRule.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.notifications#EventRuleStatusReason", "traits": { "smithy.api#documentation": "

A human-readable reason for EventRuleStatus.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Provides additional information about the current EventRule status.

" } }, "com.amazonaws.notifications#EventRuleStructure": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN for the NotificationConfiguration associated with this EventRule.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the EventRule.

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "managedRules": { "target": "com.amazonaws.notifications#ManagedRuleArns", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "statusSummaryByRegion": { "target": "com.amazonaws.notifications#StatusSummaryByRegion", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains a complete list of fields related to an EventRule.

" } }, "com.amazonaws.notifications#EventRules": { "type": "list", "member": { "target": "com.amazonaws.notifications#EventRuleStructure" } }, "com.amazonaws.notifications#EventStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "HEALTHY", "value": "HEALTHY" }, { "name": "UNHEALTHY", "value": "UNHEALTHY" } ] } }, "com.amazonaws.notifications#EventType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([a-zA-Z0-9 \\-\\(\\)])+$" } }, "com.amazonaws.notifications#GetEventRule": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetEventRuleRequest" }, "output": { "target": "com.amazonaws.notifications#GetEventRuleResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get an EventRule" }, "smithy.api#documentation": "

Returns a specified EventRule.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/event-rules/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetEventRuleRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetEventRuleResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of a NotificationConfiguration.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The date when the EventRule was created.

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "managedRules": { "target": "com.amazonaws.notifications#ManagedRuleArns", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "statusSummaryByRegion": { "target": "com.amazonaws.notifications#StatusSummaryByRegion", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetManagedNotificationChildEvent": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetManagedNotificationChildEventRequest" }, "output": { "target": "com.amazonaws.notifications#GetManagedNotificationChildEventResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get a Managed Notification Child Event" }, "smithy.api#documentation": "

Returns the child event of a specific given ManagedNotificationEvent.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/managed-notification-child-events/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetManagedNotificationChildEventRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationChildEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetManagedNotificationChildEventResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationChildEventArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.notifications#ManagedNotificationChildEvent", "traits": { "smithy.api#documentation": "

The content of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetManagedNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetManagedNotificationConfigurationRequest" }, "output": { "target": "com.amazonaws.notifications#GetManagedNotificationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get a Managed Notification Configuration" }, "smithy.api#documentation": "

Returns a specified ManagedNotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/managed-notification-configurations/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetManagedNotificationConfigurationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetManagedNotificationConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The ARN of the ManagedNotificationConfiguration resource.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationName", "traits": { "smithy.api#documentation": "

The name of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "category": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The category of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "subCategory": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The subCategory of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetManagedNotificationEvent": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetManagedNotificationEventRequest" }, "output": { "target": "com.amazonaws.notifications#GetManagedNotificationEventResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get a Managed NotificationEvent" }, "smithy.api#documentation": "

Returns a specified ManagedNotificationEvent.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/managed-notification-events/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetManagedNotificationEventRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetManagedNotificationEventResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The ARN of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.notifications#ManagedNotificationEvent", "traits": { "smithy.api#documentation": "

The content of the ManagedNotificationEvent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetNotificationConfigurationRequest" }, "output": { "target": "com.amazonaws.notifications#GetNotificationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get a NotificationConfiguration" }, "smithy.api#documentation": "

Returns a specified NotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/notification-configurations/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetNotificationConfigurationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetNotificationConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#NotificationConfigurationName", "traits": { "smithy.api#documentation": "

The name of the NotificationConfiguration.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.notifications#NotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the NotificationConfiguration.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.notifications#NotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The status of this NotificationConfiguration.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the NotificationConfiguration.

", "smithy.api#required": {} } }, "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

" } }, "subtype": { "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", "traits": { "smithy.api#documentation": "

The subtype of the notification configuration returned in the response.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetNotificationEvent": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetNotificationEventRequest" }, "output": { "target": "com.amazonaws.notifications#GetNotificationEventResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get a NotificationEvent" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/notification-events/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetNotificationEventRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetNotificationEventResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the NotificationConfiguration.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the NotificationEvent.

", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.notifications#NotificationEventSchema", "traits": { "smithy.api#documentation": "

The content of the NotificationEvent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#GetNotificationsAccessForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.notifications#GetNotificationsAccessForOrganizationRequest" }, "output": { "target": "com.amazonaws.notifications#GetNotificationsAccessForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to read Service Trust for AWS User Notifications" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/organization/access" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#GetNotificationsAccessForOrganizationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#GetNotificationsAccessForOrganizationResponse": { "type": "structure", "members": { "notificationsAccessForOrganization": { "target": "com.amazonaws.notifications#NotificationsAccessForOrganization", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Unexpected error during processing of request.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.notifications#LastActivationTime": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.notifications#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListChannelsRequest" }, "output": { "target": "com.amazonaws.notifications#ListChannelsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Channels by NotificationConfiguration" }, "smithy.api#documentation": "

Returns a list of Channels for a NotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/channels" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "channels" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListChannelsRequest": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "smithy.api#httpQuery": "notificationConfigurationArn", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListChannelsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "channels": { "target": "com.amazonaws.notifications#Channels", "traits": { "smithy.api#documentation": "

A list of Channels.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListEventRules": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListEventRulesRequest" }, "output": { "target": "com.amazonaws.notifications#ListEventRulesResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list EventRules" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/event-rules" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "eventRules" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListEventRulesRequest": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration.

", "smithy.api#httpQuery": "notificationConfigurationArn", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListEventRulesResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "eventRules": { "target": "com.amazonaws.notifications#EventRules", "traits": { "smithy.api#documentation": "

A list of EventRules.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListManagedNotificationChannelAssociations": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListManagedNotificationChannelAssociationsRequest" }, "output": { "target": "com.amazonaws.notifications#ListManagedNotificationChannelAssociationsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Account contacts and Channels associated with a Managed Notification Configuration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/channels/list-managed-notification-channel-associations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "channelAssociations" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListManagedNotificationChannelAssociationsRequest": { "type": "structure", "members": { "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "managedNotificationConfigurationArn", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListManagedNotificationChannelAssociationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "channelAssociations": { "target": "com.amazonaws.notifications#ManagedNotificationChannelAssociations", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListManagedNotificationChildEvents": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListManagedNotificationChildEventsRequest" }, "output": { "target": "com.amazonaws.notifications#ListManagedNotificationChildEventsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Managed Notification Child Events" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/list-managed-notification-child-events/{aggregateManagedNotificationEventArn}" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "managedNotificationChildEvents" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListManagedNotificationChildEventsRequest": { "type": "structure", "members": { "aggregateManagedNotificationEventArn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The earliest time of events to return from this call.

", "smithy.api#httpQuery": "startTime", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Latest time of events to return from this call.

", "smithy.api#httpQuery": "endTime", "smithy.api#timestampFormat": "date-time" } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "relatedAccount" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "organizationalUnitId" } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListManagedNotificationChildEventsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "managedNotificationChildEvents": { "target": "com.amazonaws.notifications#ManagedNotificationChildEvents", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListManagedNotificationConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListManagedNotificationConfigurationsRequest" }, "output": { "target": "com.amazonaws.notifications#ListManagedNotificationConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Managed Notification Configurations" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/managed-notification-configurations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "managedNotificationConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListManagedNotificationConfigurationsRequest": { "type": "structure", "members": { "channelIdentifier": { "target": "com.amazonaws.notifications#ChannelIdentifier", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "channelIdentifier" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListManagedNotificationConfigurationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "managedNotificationConfigurations": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurations", "traits": { "smithy.api#documentation": "

A list of Managed Notification Configurations matching the request criteria.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListManagedNotificationEvents": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListManagedNotificationEventsRequest" }, "output": { "target": "com.amazonaws.notifications#ListManagedNotificationEventsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Managed Notification Events" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/managed-notification-events" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "managedNotificationEvents" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListManagedNotificationEventsSuccess", "params": { "maxResults": 3 }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.notifications#ListManagedNotificationEventsRequest": { "type": "structure", "members": { "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The earliest time of events to return from this call.

", "smithy.api#httpQuery": "startTime", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Latest time of events to return from this call.

", "smithy.api#httpQuery": "endTime", "smithy.api#timestampFormat": "date-time" } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "source" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "organizationalUnitId" } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "relatedAccount" } }, "includeSensitiveEvents": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to include sensitive events in the result. By default, only non-sensitive events are returned. The notifications:AccessSensitiveEvents permission controls access to sensitive events.

", "smithy.api#httpQuery": "includeSensitiveEvents" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListManagedNotificationEventsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "managedNotificationEvents": { "target": "com.amazonaws.notifications#ManagedNotificationEvents", "traits": { "smithy.api#documentation": "

A list of Managed Notification Events matching the request criteria.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListMemberAccounts": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListMemberAccountsRequest" }, "output": { "target": "com.amazonaws.notifications#ListMemberAccountsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list MemberAccounts by AdminNotificationConfiguration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/list-member-accounts" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "memberAccounts" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListMemberAccountsRequest": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "notificationConfigurationArn", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } }, "memberAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The member account identifier used to filter the results.

", "smithy.api#httpQuery": "memberAccount" } }, "status": { "target": "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The status used to filter the member accounts.

", "smithy.api#httpQuery": "status" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The organizational unit ID used to filter the member accounts.

", "smithy.api#httpQuery": "organizationalUnitId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListMemberAccountsResponse": { "type": "structure", "members": { "memberAccounts": { "target": "com.amazonaws.notifications#MemberAccounts", "traits": { "smithy.api#documentation": "

The list of member accounts that match the specified criteria.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

The token to use for the next page of results.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListNotificationConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListNotificationConfigurationsRequest" }, "output": { "target": "com.amazonaws.notifications#ListNotificationConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list NotificationConfigurations" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/notification-configurations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "notificationConfigurations" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListNotificationConfigurationsSuccess", "params": { "status": "ACTIVE", "maxResults": 3 }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.notifications#ListNotificationConfigurationsRequest": { "type": "structure", "members": { "eventRuleSource": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "eventRuleSource" } }, "channelArn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "channelArn" } }, "status": { "target": "com.amazonaws.notifications#NotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The NotificationConfiguration status to match.

", "smithy.api#httpQuery": "status" } }, "subtype": { "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "subtype" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListNotificationConfigurationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "notificationConfigurations": { "target": "com.amazonaws.notifications#NotificationConfigurations", "traits": { "smithy.api#documentation": "

The NotificationConfigurations in the account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListNotificationEvents": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListNotificationEventsRequest" }, "output": { "target": "com.amazonaws.notifications#ListNotificationEventsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list NotificationEvents" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/notification-events" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "notificationEvents" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListNotificationEventsSuccess", "params": { "includeChildEvents": true, "maxResults": 3 }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.notifications#ListNotificationEventsRequest": { "type": "structure", "members": { "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The earliest time of events to return from this call.

", "smithy.api#httpQuery": "startTime", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Latest time of events to return from this call.

", "smithy.api#httpQuery": "endTime", "smithy.api#timestampFormat": "date-time" } }, "locale": { "target": "com.amazonaws.notifications#LocaleCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "locale" } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "source" } }, "includeChildEvents": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include aggregated child events in the result.

", "smithy.api#httpQuery": "includeChildEvents" } }, "aggregateNotificationEventArn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "aggregateNotificationEventArn" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "organizationalUnitId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListNotificationEventsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } }, "notificationEvents": { "target": "com.amazonaws.notifications#NotificationEvents", "traits": { "smithy.api#documentation": "

The list of notification events.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListNotificationHubs": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListNotificationHubsRequest" }, "output": { "target": "com.amazonaws.notifications#ListNotificationHubsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list NotificationHubs" }, "smithy.api#documentation": "

Returns a list of NotificationHubs.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/notification-hubs" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "notificationHubs" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListNotificationHubsSuccess", "params": { "maxResults": 3 }, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.notifications#ListNotificationHubsRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 3, "max": 3 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListNotificationHubsResponse": { "type": "structure", "members": { "notificationHubs": { "target": "com.amazonaws.notifications#NotificationHubs", "traits": { "smithy.api#documentation": "

The NotificationHubs in the account.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListOrganizationalUnits": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListOrganizationalUnitsRequest" }, "output": { "target": "com.amazonaws.notifications#ListOrganizationalUnitsResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list Organizational Units by NotificationConfiguration" }, "smithy.api#documentation": "

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

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/organizational-units" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "organizationalUnits" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListOrganizationalUnitsRequest": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "notificationConfigurationArn", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListOrganizationalUnitsResponse": { "type": "structure", "members": { "organizationalUnits": { "target": "com.amazonaws.notifications#OrganizationalUnits", "traits": { "smithy.api#documentation": "

The list of organizational units that match the specified criteria.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.notifications#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.notifications#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to get tags for a resource" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{arn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.notifications#ListTagsForResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.notifications#TagMap", "traits": { "smithy.api#documentation": "

A list of tags for the specified ARN.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#LocaleCode": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "de_DE", "value": "de_DE", "documentation": "German (Germany)" }, { "name": "en_CA", "value": "en_CA", "documentation": "English (Canada)" }, { "name": "en_US", "value": "en_US", "documentation": "English (United States). This is the default locale." }, { "name": "en_UK", "value": "en_UK", "documentation": "English (United Kingdom)" }, { "name": "es_ES", "value": "es_ES", "documentation": "Spanish (Spain)" }, { "name": "fr_CA", "value": "fr_CA", "documentation": "French (Canada)" }, { "name": "fr_FR", "value": "fr_FR", "documentation": "French (France)" }, { "name": "id_ID", "value": "id_ID", "documentation": "Bahasa Indonesian (Indonesia)" }, { "name": "it_IT", "value": "it_IT", "documentation": "Italian (Italy)" }, { "name": "ja_JP", "value": "ja_JP", "documentation": "Japanese (Japan)" }, { "name": "ko_KR", "value": "ko_KR", "documentation": "Korean (Korea)" }, { "name": "pt_BR", "value": "pt_BR", "documentation": "Portuguese (Brazil)" }, { "name": "tr_TR", "value": "tr_TR", "documentation": "Turkish (Turkey)" }, { "name": "zh_CN", "value": "zh_CN", "documentation": "Chinese (China)" }, { "name": "zh_TW", "value": "zh_TW", "documentation": "Chinese (Taiwan)" } ], "smithy.api#suppress": [ "EnumTrait" ] } }, "com.amazonaws.notifications#ManagedNotificationAccountContactAssociation": { "type": "resource", "identifiers": { "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn" }, "contactIdentifier": { "target": "com.amazonaws.notifications#AccountContactType" } }, "put": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAccountContact" }, "delete": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAccountContact" }, "traits": { "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#ManagedNotificationAdditionalChannelAssociation": { "type": "resource", "identifiers": { "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn" }, "channelArn": { "target": "com.amazonaws.notifications#ChannelArn" } }, "put": { "target": "com.amazonaws.notifications#AssociateManagedNotificationAdditionalChannel" }, "delete": { "target": "com.amazonaws.notifications#DisassociateManagedNotificationAdditionalChannel" }, "traits": { "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#ManagedNotificationChannelAssociationSummary": { "type": "structure", "members": { "channelIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier for the notification channel.

", "smithy.api#required": {} } }, "channelType": { "target": "com.amazonaws.notifications#ChannelType", "traits": { "smithy.api#documentation": "

The type of notification channel used for message delivery.

", "smithy.api#required": {} } }, "overrideOption": { "target": "com.amazonaws.notifications#ChannelAssociationOverrideOption", "traits": { "smithy.api#documentation": "

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

" } }, "isSensitiveEventsSubscribed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether this channel association is subscribed to sensitive events. Defaults to false for associations created without the flag.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#ManagedNotificationChannelAssociations": { "type": "list", "member": { "target": "com.amazonaws.notifications#ManagedNotificationChannelAssociationSummary" } }, "com.amazonaws.notifications#ManagedNotificationChannelIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^(ACCOUNT_PRIMARY|ACCOUNT_ALTERNATE_BILLING|ACCOUNT_ALTERNATE_OPERATIONS|ACCOUNT_ALTERNATE_SECURITY|arn:[a-z-]{3,10}:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+)$" } }, "com.amazonaws.notifications#ManagedNotificationChildEvent": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

The schema version of the Managed Notification Child Event.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.notifications#NotificationEventId", "traits": { "smithy.api#documentation": "

The unique identifier for a Managed Notification Child Event.

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponents", "traits": { "smithy.api#required": {} } }, "sourceEventDetailUrl": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

The source event URL.

" } }, "sourceEventDetailUrlDisplayText": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The detailed URL for the source event.

" } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The type of event causing the notification.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

The assesed nature of the event.

" } }, "aggregateManagedNotificationEventArn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The notification event start time.

", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The end time of the event.

", "smithy.api#timestampFormat": "date-time" } }, "textParts": { "target": "com.amazonaws.notifications#TextParts", "traits": { "smithy.api#documentation": "

A list of text values.

", "smithy.api#required": {} } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

" } }, "aggregationDetail": { "target": "com.amazonaws.notifications#AggregationDetail", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#ManagedNotificationChildEventArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.notifications#Notifications", "resource": "com.amazonaws.notifications#ManagedNotificationChildEvent" }, "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}/event/[a-z0-9]{27}/child-event/[a-z0-9]{27}$" } }, "com.amazonaws.notifications#ManagedNotificationChildEventOverview": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The account that related to the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "childEvent": { "target": "com.amazonaws.notifications#ManagedNotificationChildEventSummary", "traits": { "smithy.api#documentation": "

The content of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "aggregateManagedNotificationEventArn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The Organizational Unit Id that an AWS account belongs to.

" } } }, "traits": { "smithy.api#documentation": "

Describes an overview and metadata for a ManagedNotificationChildEvent.

" } }, "com.amazonaws.notifications#ManagedNotificationChildEventResource": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationChildEventArn" } }, "read": { "target": "com.amazonaws.notifications#GetManagedNotificationChildEvent" }, "list": { "target": "com.amazonaws.notifications#ListManagedNotificationChildEvents" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true } } }, "com.amazonaws.notifications#ManagedNotificationChildEventSummary": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

The schema version of the ManagedNotificationChildEvent.

", "smithy.api#required": {} } }, "sourceEventMetadata": { "target": "com.amazonaws.notifications#ManagedSourceEventMetadataSummary", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponentsSummary", "traits": { "smithy.api#required": {} } }, "aggregationDetail": { "target": "com.amazonaws.notifications#AggregationDetail", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

The perceived nature of the event.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The Type of the event causing this notification.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a short summary and metadata for a ManagedNotificationChildEvent.

" } }, "com.amazonaws.notifications#ManagedNotificationChildEvents": { "type": "list", "member": { "target": "com.amazonaws.notifications#ManagedNotificationChildEventOverview" } }, "com.amazonaws.notifications#ManagedNotificationConfiguration": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn" } }, "read": { "target": "com.amazonaws.notifications#GetManagedNotificationConfiguration" }, "list": { "target": "com.amazonaws.notifications#ListManagedNotificationConfigurations" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true }, "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#ManagedNotificationConfigurationDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[^\\u0001-\\u001F\\u007F-\\u009F]*$" } }, "com.amazonaws.notifications#ManagedNotificationConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9\\-]+$" } }, "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}$" } }, "com.amazonaws.notifications#ManagedNotificationConfigurationStructure": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationName", "traits": { "smithy.api#documentation": "

The name of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the basic structure and properties of a ManagedNotificationConfiguration.

" } }, "com.amazonaws.notifications#ManagedNotificationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationStructure" } }, "com.amazonaws.notifications#ManagedNotificationEvent": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

Version of the ManagedNotificationEvent schema.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.notifications#NotificationEventId", "traits": { "smithy.api#documentation": "

Unique identifier for a ManagedNotificationEvent.

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponents", "traits": { "smithy.api#required": {} } }, "sourceEventDetailUrl": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

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

" } }, "sourceEventDetailUrlDisplayText": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

" } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The nature of the event causing this notification.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

The status of an event.

" } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { "smithy.api#documentation": "

The notifications aggregation type.

" } }, "aggregationSummary": { "target": "com.amazonaws.notifications#AggregationSummary" }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The earliest time of events to return from this call.

", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The end time of the notification event.

", "smithy.api#timestampFormat": "date-time" } }, "textParts": { "target": "com.amazonaws.notifications#TextParts", "traits": { "smithy.api#documentation": "

A list of text values.

", "smithy.api#required": {} } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

" } }, "attachments": { "target": "com.amazonaws.notifications#NotificationEventAttachmentList", "traits": { "smithy.api#documentation": "

A list of files attached to the notification event.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#ManagedNotificationEventArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.notifications#Notifications", "resource": "com.amazonaws.notifications#ManagedNotificationEvent" }, "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}/event/[a-z0-9]{27}$" } }, "com.amazonaws.notifications#ManagedNotificationEventOverview": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

", "smithy.api#required": {} } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The account that related to the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "notificationEvent": { "target": "com.amazonaws.notifications#ManagedNotificationEventSummary", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { "smithy.api#documentation": "

The notifications aggregation type.

" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

" } }, "aggregationSummary": { "target": "com.amazonaws.notifications#AggregationSummary" }, "aggregatedNotificationRegions": { "target": "com.amazonaws.notifications#AggregatedNotificationRegions", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

Describes an overview and metadata for a ManagedNotificationEvent.

" } }, "com.amazonaws.notifications#ManagedNotificationEventResource": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#ManagedNotificationEventArn" } }, "read": { "target": "com.amazonaws.notifications#GetManagedNotificationEvent" }, "list": { "target": "com.amazonaws.notifications#ListManagedNotificationEvents" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true } } }, "com.amazonaws.notifications#ManagedNotificationEventSummary": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

The schema version of the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "sourceEventMetadata": { "target": "com.amazonaws.notifications#ManagedSourceEventMetadataSummary", "traits": { "smithy.api#documentation": "

Contains metadata about the event that caused the ManagedNotificationEvent.

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponentsSummary", "traits": { "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

The managed notification event status.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The Type of event causing the notification.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#ManagedNotificationEvents": { "type": "list", "member": { "target": "com.amazonaws.notifications#ManagedNotificationEventOverview" } }, "com.amazonaws.notifications#ManagedRuleArn": { "type": "string", "traits": { "aws.api#arnReference": {}, "smithy.api#pattern": "^arn:[a-z-]{3,10}:events:[a-z-\\d]{2,25}:\\d{12}:rule\\/[a-zA-Z-\\d]{1,1024}$" } }, "com.amazonaws.notifications#ManagedRuleArns": { "type": "list", "member": { "target": "com.amazonaws.notifications#ManagedRuleArn" } }, "com.amazonaws.notifications#ManagedSourceEventMetadataSummary": { "type": "structure", "members": { "eventOriginRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The Region where the notification originated.

", "smithy.api#length": { "max": 32 } } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { "smithy.api#documentation": "

The event Type of the notification.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A short summary and metadata for a managed notification event.

" } }, "com.amazonaws.notifications#Media": { "type": "list", "member": { "target": "com.amazonaws.notifications#MediaElement" } }, "com.amazonaws.notifications#MediaElement": { "type": "structure", "members": { "mediaId": { "target": "com.amazonaws.notifications#MediaId", "traits": { "smithy.api#documentation": "

The unique ID for the media.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.notifications#MediaElementType", "traits": { "smithy.api#documentation": "

The type of media.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

The URL of the media.

", "smithy.api#required": {} } }, "caption": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

The caption of the media.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a media element.

" } }, "com.amazonaws.notifications#MediaElementType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "IMAGE", "value": "IMAGE" } ] } }, "com.amazonaws.notifications#MediaId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.notifications#MemberAccount": { "type": "structure", "members": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

" } }, "accountId": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The AWS account ID of the member account.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The current status of the member account.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the current status of the member account.

", "smithy.api#required": {} } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about a member account.

" } }, "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "ACTIVE", "documentation": "The member account Notification Configuration status is ACTIVE." }, { "name": "PENDING", "value": "PENDING", "documentation": "The member account Notification Configuration status is PENDING." }, { "name": "INACTIVE", "value": "INACTIVE", "documentation": "The member account Notification Configuration status is INACTIVE." }, { "name": "CREATING", "value": "CREATING", "documentation": "The member account Notification Configuration status is CREATING." }, { "name": "DELETING", "value": "DELETING", "documentation": "The member account Notification Configuration status is DELETING." } ] } }, "com.amazonaws.notifications#MemberAccounts": { "type": "list", "member": { "target": "com.amazonaws.notifications#MemberAccount" } }, "com.amazonaws.notifications#MessageComponents": { "type": "structure", "members": { "headline": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

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

" } }, "paragraphSummary": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

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

" } }, "completeDescription": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

A complete summary with all possible relevant information.

" } }, "markupDescription": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { "smithy.api#documentation": "

A rich description in Portable Text format, which you can convert to markup formats such as HTML, Markdown, or plain text. Channels that don't support rich rendering ignore this field and use the plain text components instead.

" } }, "dimensions": { "target": "com.amazonaws.notifications#Dimensions", "traits": { "smithy.api#documentation": "

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.

" } } }, "traits": { "smithy.api#documentation": "

Describes the components of a notification message.

" } }, "com.amazonaws.notifications#MessageComponentsSummary": { "type": "structure", "members": { "headline": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains the headline message component.

" } }, "com.amazonaws.notifications#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^[\\w+-/=]+$" } }, "com.amazonaws.notifications#NotificationConfiguration": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn" } }, "put": { "target": "com.amazonaws.notifications#UpdateNotificationConfiguration" }, "create": { "target": "com.amazonaws.notifications#CreateNotificationConfiguration" }, "read": { "target": "com.amazonaws.notifications#GetNotificationConfiguration" }, "delete": { "target": "com.amazonaws.notifications#DeleteNotificationConfiguration" }, "list": { "target": "com.amazonaws.notifications#ListNotificationConfigurations" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true }, "aws.cloudformation#cfnResource": {} } }, "com.amazonaws.notifications#NotificationConfigurationArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.notifications#Notifications", "resource": "com.amazonaws.notifications#NotificationConfiguration" }, "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications::[0-9]{12}:configuration/[a-z0-9]{27}$" } }, "com.amazonaws.notifications#NotificationConfigurationDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[^\\u0001-\\u001F\\u007F-\\u009F]*$" } }, "com.amazonaws.notifications#NotificationConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_\\-]+$" } }, "com.amazonaws.notifications#NotificationConfigurationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "ACTIVE", "documentation": "All of the EventRules are in ACTIVE Status. Any call can be executed." }, { "name": "PARTIALLY_ACTIVE", "value": "PARTIALLY_ACTIVE", "documentation": "Some EventRules are in ACTIVE Status and some are INACTIVE. Any call can be executed." }, { "name": "INACTIVE", "value": "INACTIVE", "documentation": "All of the EventRules are in INACTIVE Status. Any call can be executed." }, { "name": "DELETING", "value": "DELETING", "documentation": "This NotificationConfiguration is being deleted. Only GET/LIST calls can be executed." } ] } }, "com.amazonaws.notifications#NotificationConfigurationStructure": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#NotificationConfigurationName", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.notifications#NotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the NotificationConfiguration.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.notifications#NotificationConfigurationStatus", "traits": { "smithy.api#documentation": "

The current status of the NotificationConfiguration.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the NotificationConfiguration.

", "smithy.api#required": {} } }, "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

" } }, "subtype": { "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", "traits": { "smithy.api#documentation": "

The subtype of the notification configuration.

" } } }, "traits": { "smithy.api#documentation": "

Contains the complete list of fields for a NotificationConfiguration.

" } }, "com.amazonaws.notifications#NotificationConfigurationSubtype": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACCOUNT", "value": "ACCOUNT", "documentation": "Notification configuration created by the account" }, { "name": "ADMIN_MANAGED", "value": "ADMIN_MANAGED", "documentation": "Notification configuration managed by an administrator account" } ] } }, "com.amazonaws.notifications#NotificationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.notifications#NotificationConfigurationStructure" } }, "com.amazonaws.notifications#NotificationEventArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.notifications#Notifications", "resource": "com.amazonaws.notifications#NotificationEventSchema" }, "smithy.api#pattern": "^arn:[a-z-]{3,10}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}$" } }, "com.amazonaws.notifications#NotificationEventAttachment": { "type": "structure", "members": { "displayName": { "target": "com.amazonaws.notifications#AttachmentDisplayName", "traits": { "smithy.api#documentation": "

The name of the attachment that recipients see.

", "smithy.api#required": {} } }, "attachmentDownloadUrl": { "target": "com.amazonaws.notifications#SensitiveUrl", "traits": { "smithy.api#documentation": "

A temporary URL for downloading the attachment. The URL expires shortly after it's issued.

" } }, "contentType": { "target": "com.amazonaws.notifications#AttachmentContentType", "traits": { "smithy.api#documentation": "

The MIME content type of the attachment, for example application/pdf.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A file attached to a notification event.

" } }, "com.amazonaws.notifications#NotificationEventAttachmentList": { "type": "list", "member": { "target": "com.amazonaws.notifications#NotificationEventAttachment" } }, "com.amazonaws.notifications#NotificationEventId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{27}$" } }, "com.amazonaws.notifications#NotificationEventOverview": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the NotificationConfiguration.

", "smithy.api#required": {} } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The account name containing the NotificationHub.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The creation time of the NotificationEvent.

", "smithy.api#required": {} } }, "notificationEvent": { "target": "com.amazonaws.notifications#NotificationEventSummary", "traits": { "smithy.api#documentation": "

Refers to a NotificationEventSummary object.

Similar in structure to content in the GetNotificationEvent response.

", "smithy.api#required": {} } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { "smithy.api#documentation": "

The NotificationConfiguration's aggregation type.

" } }, "aggregateNotificationEventArn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

The ARN of the aggregatedNotificationEventArn to match.

" } }, "aggregationSummary": { "target": "com.amazonaws.notifications#AggregationSummary", "traits": { "smithy.api#documentation": "

Provides an aggregated summary data for notification events.

" } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#NotificationEventResource": { "type": "resource", "identifiers": { "arn": { "target": "com.amazonaws.notifications#NotificationEventArn" } }, "read": { "target": "com.amazonaws.notifications#GetNotificationEvent" }, "list": { "target": "com.amazonaws.notifications#ListNotificationEvents" }, "traits": { "aws.api#arn": { "template": "{arn}", "absolute": true } } }, "com.amazonaws.notifications#NotificationEventSchema": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

The schema version of the Notification Event.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.notifications#NotificationEventId", "traits": { "smithy.api#documentation": "

The unique identifier for a NotificationEvent.

", "smithy.api#required": {} } }, "sourceEventMetadata": { "target": "com.amazonaws.notifications#SourceEventMetadata", "traits": { "smithy.api#documentation": "

The source event metadata.

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponents", "traits": { "smithy.api#required": {} } }, "sourceEventDetailUrl": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

The source event URL.

" } }, "sourceEventDetailUrlDisplayText": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The detailed URL for the source event.

" } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The type of event causing the notification.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

The assessed nature of the event.

" } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { "smithy.api#documentation": "

The aggregation type of the NotificationConfiguration.

" } }, "aggregateNotificationEventArn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { "smithy.api#documentation": "

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.

" } }, "aggregationSummary": { "target": "com.amazonaws.notifications#AggregationSummary", "traits": { "smithy.api#documentation": "

Provides additional information about how multiple notifications are grouped.

" } }, "startTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The notification event start time.

", "smithy.api#timestampFormat": "date-time" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The end time of the event.

", "smithy.api#timestampFormat": "date-time" } }, "textParts": { "target": "com.amazonaws.notifications#TextParts", "traits": { "smithy.api#documentation": "

A list of text values.

", "smithy.api#required": {} } }, "media": { "target": "com.amazonaws.notifications#Media", "traits": { "smithy.api#documentation": "

A list of media elements.

", "smithy.api#required": {} } }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#NotificationEventSummary": { "type": "structure", "members": { "schemaVersion": { "target": "com.amazonaws.notifications#SchemaVersion", "traits": { "smithy.api#documentation": "

The schema version of the Notification Event.

", "smithy.api#required": {} } }, "sourceEventMetadata": { "target": "com.amazonaws.notifications#SourceEventMetadataSummary", "traits": { "smithy.api#documentation": "

The source event metadata.

", "smithy.api#required": {} } }, "messageComponents": { "target": "com.amazonaws.notifications#MessageComponentsSummary", "traits": { "smithy.api#documentation": "

The message components of a notification event.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { "smithy.api#documentation": "

Provides additional information about the current status of the NotificationEvent.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { "smithy.api#documentation": "

The type of event causing the notification.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a short summary and metadata for a NotificationEvent.

" } }, "com.amazonaws.notifications#NotificationEvents": { "type": "list", "member": { "target": "com.amazonaws.notifications#NotificationEventOverview" } }, "com.amazonaws.notifications#NotificationHub": { "type": "resource", "identifiers": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region" } }, "put": { "target": "com.amazonaws.notifications#RegisterNotificationHub" }, "delete": { "target": "com.amazonaws.notifications#DeregisterNotificationHub" }, "list": { "target": "com.amazonaws.notifications#ListNotificationHubs" }, "traits": { "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {}, "smithy.api#noReplace": {} } }, "com.amazonaws.notifications#NotificationHubOverview": { "type": "structure", "members": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The Region of the resource.

", "smithy.api#required": {} } }, "statusSummary": { "target": "com.amazonaws.notifications#NotificationHubStatusSummary", "traits": { "smithy.api#documentation": "

The status summary of the resource.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The date and time the NotificationHubOverview was created.

", "smithy.api#required": {} } }, "lastActivationTime": { "target": "com.amazonaws.notifications#LastActivationTime", "traits": { "smithy.api#documentation": "

The most recent time this NotificationHub had an ACTIVE status.

" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.notifications#NotificationHubStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ACTIVE", "value": "ACTIVE", "documentation": "Incoming Notification Events are being replicated to this Notification Hub. A Notification Hub with this status can be deregistered." }, { "name": "REGISTERING", "value": "REGISTERING", "documentation": "Notification Hub is initializing. Cannot deregister a Notification Hub in this status." }, { "name": "DEREGISTERING", "value": "DEREGISTERING", "documentation": "Notification Hub is being deleted. Cannot register a Notification Hub in the same region as one in this status." }, { "name": "INACTIVE", "value": "INACTIVE", "documentation": "Notification Hub is in a failure state. Incoming Notification Events are not being replicated to this Hub." } ] } }, "com.amazonaws.notifications#NotificationHubStatusReason": { "type": "string" }, "com.amazonaws.notifications#NotificationHubStatusSummary": { "type": "structure", "members": { "status": { "target": "com.amazonaws.notifications#NotificationHubStatus", "traits": { "smithy.api#documentation": "

Status information about the NotificationHub.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.notifications#NotificationHubStatusReason", "traits": { "smithy.api#documentation": "

An explanation for the current status.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Provides additional information about the current NotificationHub status.

" } }, "com.amazonaws.notifications#NotificationHubs": { "type": "list", "member": { "target": "com.amazonaws.notifications#NotificationHubOverview" } }, "com.amazonaws.notifications#NotificationType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "ALERT", "value": "ALERT" }, { "name": "WARNING", "value": "WARNING" }, { "name": "ANNOUNCEMENT", "value": "ANNOUNCEMENT" }, { "name": "INFORMATIONAL", "value": "INFORMATIONAL" } ] } }, "com.amazonaws.notifications#Notifications": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.notifications#ListManagedNotificationChannelAssociations" }, { "target": "com.amazonaws.notifications#ListMemberAccounts" }, { "target": "com.amazonaws.notifications#ListTagsForResource" }, { "target": "com.amazonaws.notifications#TagResource" }, { "target": "com.amazonaws.notifications#UntagResource" }, { "target": "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociation" } ], "resources": [ { "target": "com.amazonaws.notifications#Channel" }, { "target": "com.amazonaws.notifications#EventRule" }, { "target": "com.amazonaws.notifications#ManagedNotificationAccountContactAssociation" }, { "target": "com.amazonaws.notifications#ManagedNotificationAdditionalChannelAssociation" }, { "target": "com.amazonaws.notifications#ManagedNotificationChildEventResource" }, { "target": "com.amazonaws.notifications#ManagedNotificationConfiguration" }, { "target": "com.amazonaws.notifications#ManagedNotificationEventResource" }, { "target": "com.amazonaws.notifications#NotificationConfiguration" }, { "target": "com.amazonaws.notifications#NotificationEventResource" }, { "target": "com.amazonaws.notifications#NotificationHub" }, { "target": "com.amazonaws.notifications#OrganizationAccess" }, { "target": "com.amazonaws.notifications#OrganizationalUnit" } ], "traits": { "aws.api#service": { "sdkId": "Notifications", "arnNamespace": "notifications", "endpointPrefix": "notifications", "cloudTrailEventSource": "notifications.amazonaws.com" }, "aws.auth#sigv4": { "name": "notifications" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id" ], "maxAge": 86400 }, "smithy.api#documentation": "

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.

", "smithy.api#title": "AWS User Notifications", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://notifications-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://notifications.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://notifications-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://notifications.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://notifications.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.notifications#NotificationsAccessForOrganization": { "type": "structure", "members": { "accessStatus": { "target": "com.amazonaws.notifications#AccessStatus", "traits": { "smithy.api#documentation": "

Access Status for the Orgs Service.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Orgs Service trust for User Notifications.

" } }, "com.amazonaws.notifications#OrganizationAccess": { "type": "resource", "put": { "target": "com.amazonaws.notifications#EnableNotificationsAccessForOrganization" }, "read": { "target": "com.amazonaws.notifications#GetNotificationsAccessForOrganization" }, "delete": { "target": "com.amazonaws.notifications#DisableNotificationsAccessForOrganization" } }, "com.amazonaws.notifications#OrganizationalUnit": { "type": "resource", "identifiers": { "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn" }, "organizationalUnitId": { "target": "com.amazonaws.notifications#OrganizationalUnitId" } }, "put": { "target": "com.amazonaws.notifications#AssociateOrganizationalUnit" }, "delete": { "target": "com.amazonaws.notifications#DisassociateOrganizationalUnit" }, "list": { "target": "com.amazonaws.notifications#ListOrganizationalUnits" } }, "com.amazonaws.notifications#OrganizationalUnitId": { "type": "string", "traits": { "smithy.api#pattern": "^(Root|r-[0-9a-z]{4,32}|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.notifications#OrganizationalUnits": { "type": "list", "member": { "target": "com.amazonaws.notifications#OrganizationalUnitId" } }, "com.amazonaws.notifications#QuotaCode": { "type": "string" }, "com.amazonaws.notifications#Region": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 25 }, "smithy.api#pattern": "^([a-z]{1,4})-([a-z]{1,15}-)+([0-9])$" } }, "com.amazonaws.notifications#Regions": { "type": "list", "member": { "target": "com.amazonaws.notifications#Region" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.notifications#RegisterNotificationHub": { "type": "operation", "input": { "target": "com.amazonaws.notifications#RegisterNotificationHubRequest" }, "output": { "target": "com.amazonaws.notifications#RegisterNotificationHubResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ServiceQuotaExceededException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to register a NotificationHub" }, "smithy.api#documentation": "

Registers a NotificationHub in the specified Region.

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

", "smithy.api#http": { "code": 201, "method": "POST", "uri": "/notification-hubs" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#RegisterNotificationHubRequest": { "type": "structure", "members": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The Region of the NotificationHub.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#RegisterNotificationHubResponse": { "type": "structure", "members": { "notificationHubRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The Region of the NotificationHub.

", "smithy.api#required": {} } }, "statusSummary": { "target": "com.amazonaws.notifications#NotificationHubStatusSummary", "traits": { "smithy.api#documentation": "

Provides additional information about the current NotificationHub status information.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.notifications#CreationTime", "traits": { "smithy.api#documentation": "

The date the resource was created.

", "smithy.api#required": {} } }, "lastActivationTime": { "target": "com.amazonaws.notifications#LastActivationTime", "traits": { "smithy.api#documentation": "

The date the resource was last activated.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#Resource": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier for the resource.

At least one id or ARN is required.

" } }, "arn": { "target": "com.amazonaws.notifications#Arn", "traits": { "smithy.api#documentation": "

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

" } }, "detailUrl": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

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.

" } }, "tags": { "target": "com.amazonaws.notifications#Tags", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

A resource affected by or closely linked to an event.

" } }, "com.amazonaws.notifications#ResourceId": { "type": "string" }, "com.amazonaws.notifications#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.notifications#ResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource that wasn't found.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Request references a resource which does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.notifications#ResourceType": { "type": "string" }, "com.amazonaws.notifications#Resources": { "type": "list", "member": { "target": "com.amazonaws.notifications#Resource" } }, "com.amazonaws.notifications#SampleAggregationDimensionValues": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.notifications#SchemaVersion": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "SCHEMA_VERSION_1_0", "value": "v1.0" } ] } }, "com.amazonaws.notifications#SensitiveUrl": { "type": "string", "traits": { "smithy.api#length": { "max": 4096 }, "smithy.api#pattern": "^(https?):\\/\\/.*$", "smithy.api#sensitive": {} } }, "com.amazonaws.notifications#ServiceCode": { "type": "string" }, "com.amazonaws.notifications#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.notifications#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource that exceeds the service quota.

", "smithy.api#required": {} } }, "resourceId": { "target": "com.amazonaws.notifications#ResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource that exceeds the service quota.

" } }, "serviceCode": { "target": "com.amazonaws.notifications#ServiceCode", "traits": { "smithy.api#documentation": "

The code for the service quota exceeded in Service Quotas.

" } }, "quotaCode": { "target": "com.amazonaws.notifications#QuotaCode", "traits": { "smithy.api#documentation": "

The code for the service quota in Service Quotas.

" } } }, "traits": { "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.notifications#Source": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 }, "smithy.api#pattern": "^aws.([a-z0-9\\-])+$" } }, "com.amazonaws.notifications#SourceEventMetadata": { "type": "structure", "members": { "eventTypeVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the type of event.

", "smithy.api#length": { "min": 1, "max": 3 }, "smithy.api#pattern": "^[0-9.]+$", "smithy.api#required": {} } }, "sourceEventId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The source event id.

", "smithy.api#required": {} } }, "eventOriginRegion": { "target": "com.amazonaws.notifications#Region", "traits": { "smithy.api#documentation": "

The Region the event originated from.

", "smithy.api#length": { "max": 32 } } }, "relatedAccount": { "target": "com.amazonaws.notifications#AccountId", "traits": { "smithy.api#documentation": "

The primary Amazon Web Services account of SourceEvent.

", "smithy.api#pattern": "^[0-9]{12}$", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "eventOccurrenceTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "eventType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } }, "relatedResources": { "target": "com.amazonaws.notifications#Resources", "traits": { "smithy.api#documentation": "

A list of resources related to this NotificationEvent.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the metadata for a source event.

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

" } }, "com.amazonaws.notifications#SourceEventMetadataSummary": { "type": "structure", "members": { "eventOriginRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Region where the notification originated.

Unavailable for aggregated notifications.

", "smithy.api#length": { "max": 32 } } }, "source": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, "eventType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#StatusSummaryByRegion": { "type": "map", "key": { "target": "com.amazonaws.notifications#Region" }, "value": { "target": "com.amazonaws.notifications#EventRuleStatusSummary" } }, "com.amazonaws.notifications#SummarizationDimensionDetail": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the SummarizationDimensionDetail.

", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Value of the property used to summarize aggregated events.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#SummarizationDimensionDetails": { "type": "list", "member": { "target": "com.amazonaws.notifications#SummarizationDimensionDetail" } }, "com.amazonaws.notifications#SummarizationDimensionOverview": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Name of the summarization dimension.

", "smithy.api#required": {} } }, "count": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Total number of occurrences for this dimension.

", "smithy.api#required": {} } }, "sampleValues": { "target": "com.amazonaws.notifications#SampleAggregationDimensionValues", "traits": { "smithy.api#documentation": "

Indicates the sample values found within the dimension.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#SummarizationDimensionOverviews": { "type": "list", "member": { "target": "com.amazonaws.notifications#SummarizationDimensionOverview" } }, "com.amazonaws.notifications#TagKey": { "type": "string", "traits": { "smithy.api#pattern": "^(?!aws:).{1,128}$" } }, "com.amazonaws.notifications#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.notifications#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.notifications#TagMap": { "type": "map", "key": { "target": "com.amazonaws.notifications#TagKey" }, "value": { "target": "com.amazonaws.notifications#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.notifications#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.notifications#TagResourceRequest" }, "output": { "target": "com.amazonaws.notifications#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to tag a resource" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#TagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.notifications#TagMap", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.notifications#Tags": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.notifications#TextByLocale": { "type": "map", "key": { "target": "com.amazonaws.notifications#LocaleCode" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.notifications#TextPartId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9_]+$" } }, "com.amazonaws.notifications#TextPartReference": { "type": "string" }, "com.amazonaws.notifications#TextPartType": { "type": "string", "traits": { "smithy.api#enum": [ { "name": "LOCALIZED_TEXT", "value": "LOCALIZED_TEXT" }, { "name": "PLAIN_TEXT", "value": "PLAIN_TEXT" }, { "name": "URL", "value": "URL" }, { "name": "PORTABLE_TEXT", "value": "PORTABLE_TEXT" } ] } }, "com.amazonaws.notifications#TextPartValue": { "type": "structure", "members": { "type": { "target": "com.amazonaws.notifications#TextPartType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "displayText": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

Used for text parts with the type URL.

", "smithy.api#length": { "min": 1, "max": 12000 } } }, "textByLocale": { "target": "com.amazonaws.notifications#TextByLocale", "traits": { "smithy.api#documentation": "

A map of locales to the text in that locale.

" } }, "url": { "target": "com.amazonaws.notifications#Url", "traits": { "smithy.api#documentation": "

The URL itself.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#TextParts": { "type": "map", "key": { "target": "com.amazonaws.notifications#TextPartId" }, "value": { "target": "com.amazonaws.notifications#TextPartValue" } }, "com.amazonaws.notifications#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.notifications#ServiceCode", "traits": { "smithy.api#documentation": "

Identifies the service being throttled.

" } }, "quotaCode": { "target": "com.amazonaws.notifications#QuotaCode", "traits": { "smithy.api#documentation": "

Identifies the quota that is being throttled.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

Request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.notifications#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.notifications#UntagResourceRequest" }, "output": { "target": "com.amazonaws.notifications#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a resource" }, "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#UntagResourceRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.notifications#TagKeys", "traits": { "smithy.api#documentation": "

The tag keys to use to untag a resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#UpdateEventRule": { "type": "operation", "input": { "target": "com.amazonaws.notifications#UpdateEventRuleRequest" }, "output": { "target": "com.amazonaws.notifications#UpdateEventRuleResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to update an EventRule" }, "smithy.api#documentation": "

Updates an existing EventRule.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/event-rules/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#UpdateEventRuleRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { "smithy.api#documentation": "

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.

" } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#UpdateEventRuleResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the NotificationConfiguration.

", "smithy.api#required": {} } }, "statusSummaryByRegion": { "target": "com.amazonaws.notifications#StatusSummaryByRegion", "traits": { "smithy.api#documentation": "

The status of the action by Region.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociation": { "type": "operation", "input": { "target": "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociationRequest" }, "output": { "target": "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to toggle the sensitive-events subscription on an existing\n Managed Notification channel association" }, "smithy.api#documentation": "

Updates the isSensitiveEventsSubscribed property of a particular ManagedNotification channel association.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/channels/update-managed-notification-channel-association" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociationRequest": { "type": "structure", "members": { "managedNotificationConfigurationArn": { "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration whose Channel association property you want to update.

", "smithy.api#required": {} } }, "channelIdentifier": { "target": "com.amazonaws.notifications#ManagedNotificationChannelIdentifier", "traits": { "smithy.api#documentation": "

The identifier of the channel association to update. You can specify one of the following:

", "smithy.api#required": {} } }, "isSensitiveEventsSubscribed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether the association is subscribed to sensitive events. The notifications:SubscribeSensitiveEvents permission controls access to sensitive events.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#UpdateManagedNotificationChannelAssociationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#UpdateNotificationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.notifications#UpdateNotificationConfigurationRequest" }, "output": { "target": "com.amazonaws.notifications#UpdateNotificationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.notifications#AccessDeniedException" }, { "target": "com.amazonaws.notifications#ConflictException" }, { "target": "com.amazonaws.notifications#InternalServerException" }, { "target": "com.amazonaws.notifications#ResourceNotFoundException" }, { "target": "com.amazonaws.notifications#ThrottlingException" }, { "target": "com.amazonaws.notifications#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to update a NotificationConfiguration" }, "smithy.api#documentation": "

Updates a NotificationConfiguration.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/notification-configurations/{arn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.notifications#UpdateNotificationConfigurationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#NotificationConfigurationName", "traits": { "smithy.api#documentation": "

The name of the NotificationConfiguration.

" } }, "description": { "target": "com.amazonaws.notifications#NotificationConfigurationDescription", "traits": { "smithy.api#documentation": "

The description of the NotificationConfiguration.

" } }, "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.notifications#UpdateNotificationConfigurationResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN used to update the NotificationConfiguration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.notifications#Url": { "type": "string", "traits": { "smithy.api#length": { "max": 2000 } } }, "com.amazonaws.notifications#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.notifications#ErrorMessage", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.notifications#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason why your input is considered invalid.

" } }, "fieldList": { "target": "com.amazonaws.notifications#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

The list of input fields that are invalid.

" } } }, "traits": { "smithy.api#documentation": "

This exception is thrown when the notification event fails validation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.notifications#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The field name where the invalid entry was detected.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A message with the reason for the validation exception error.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.notifications#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.notifications#ValidationExceptionField" } }, "com.amazonaws.notifications#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "fieldValidationFailed", "name": "FIELD_VALIDATION_FAILED" }, { "value": "other", "name": "OTHER" } ] } } } }