Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.
\nThe Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account\". An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nDetective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.
\nThe Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account\". An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nDetails about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" + "smithy.api#documentation": "Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" } }, "com.amazonaws.detective#IndicatorType": { @@ -2953,7 +2953,7 @@ "IndicatorType": { "target": "com.amazonaws.detective#IndicatorType", "traits": { - "smithy.api#documentation": "For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" + "smithy.api#documentation": "For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" } }, "NextToken": { @@ -4472,7 +4472,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a data source packages for the behavior graph.
", + "smithy.api#documentation": "Starts a data source package for the Detective behavior graph.
", "smithy.api#http": { "method": "POST", "uri": "/graph/datasources/update", @@ -4493,7 +4493,7 @@ "DatasourcePackages": { "target": "com.amazonaws.detective#DatasourcePackageList", "traits": { - "smithy.api#documentation": "The data source package start for the behavior graph.
", + "smithy.api#documentation": "The data source package to start for the behavior graph.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 0618d22ea07..3bfc483196c 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -6116,7 +6116,7 @@ "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Assigns the specified IPv6 addresses to the specified network interface. You can\n specify specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies by instance type.
\nYou must specify either the IPv6 addresses or the IPv6 address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -6131,7 +6131,7 @@ "Ipv6Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
One or more IPv6 prefixes assigned to the network interface. You can't use this option if you use the Ipv6PrefixCount option.
Assigns one or more secondary private IP addresses to the specified network interface.
\nYou can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Assigns the specified secondary private IP addresses to the specified network interface.
\nYou can specify specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
\nWhen you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.
\nRemapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
\nYou can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To assign a specific secondary private IP address to an interface", @@ -6236,14 +6236,14 @@ "Ipv4Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
One or more IPv4 prefixes assigned to the network interface. You can't use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You can't use this option if you use the Ipv4 Prefixes option.
Creates a managed prefix list. You can specify one or more entries for the prefix list. \n Each entry consists of a CIDR block and an optional description.
" + "smithy.api#documentation": "Creates a managed prefix list. You can specify entries for the prefix list. \n Each entry consists of a CIDR block and an optional description.
" } }, "com.amazonaws.ec2#CreateManagedPrefixListRequest": { @@ -18991,7 +18991,7 @@ "Groups": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "The IDs of one or more security groups.
", + "smithy.api#documentation": "The IDs of the security groups.
", "smithy.api#xmlName": "SecurityGroupId" } }, @@ -37758,7 +37758,7 @@ "target": "com.amazonaws.ec2#DescribeNetworkInterfacesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more of your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nDescribes the specified network interfaces or all your network interfaces.
\nIf you have a large number of network interfaces, the operation fails unless \n you use pagination or one of the following filters: group-id, \n mac-address, private-dns-name, private-ip-address, \n private-dns-name, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.
\nThe accelerator types that must be on the instance type.
\nFor instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
Default: Any accelerator type
", + "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "smithy.api#xmlName": "acceleratorTypeSet" } }, @@ -64506,7 +64506,7 @@ "AcceleratorTypes": { "target": "com.amazonaws.ec2#AcceleratorTypeSet", "traits": { - "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nTo include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
Default: Any accelerator type
", + "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "smithy.api#xmlName": "AcceleratorType" } }, @@ -70400,6 +70400,54 @@ "traits": { "smithy.api#enumValue": "i8g.metal-24xl" } + }, + "u7i_6tb_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-6tb.112xlarge" + } + }, + "u7i_8tb_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-8tb.112xlarge" + } + }, + "u7inh_32tb_480xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7inh-32tb.480xlarge" + } + }, + "p5e_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5e.48xlarge" + } + }, + "p5en_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5en.48xlarge" + } + }, + "f2_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f2.12xlarge" + } + }, + "f2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f2.48xlarge" + } + }, + "trn2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn2.48xlarge" + } } } }, @@ -74310,7 +74358,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the IPv4 prefix option for a network interface.
" + "smithy.api#documentation": "Describes the IPv6 prefix option for a network interface.
" } }, "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse": { @@ -109212,7 +109260,7 @@ "target": "com.amazonaws.ec2#UnassignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
" + "smithy.api#documentation": "Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.
" } }, "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { @@ -109271,7 +109319,7 @@ "target": "com.amazonaws.ec2#IpPrefixList", "traits": { "aws.protocols#ec2QueryName": "UnassignedIpv6PrefixSet", - "smithy.api#documentation": "The IPv4 prefixes that have been unassigned from the network interface.
", + "smithy.api#documentation": "The IPv6 prefixes that have been unassigned from the network interface.
", "smithy.api#xmlName": "unassignedIpv6PrefixSet" } } @@ -109289,7 +109337,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.
", + "smithy.api#documentation": "Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a \n \tnetwork interface.
", "smithy.api#examples": [ { "title": "To unassign a secondary private IP address from a network interface", diff --git a/codegen/sdk-codegen/aws-models/notifications.json b/codegen/sdk-codegen/aws-models/notifications.json index 5614b4b6abf..9857e2e027f 100644 --- a/codegen/sdk-codegen/aws-models/notifications.json +++ b/codegen/sdk-codegen/aws-models/notifications.json @@ -17,12 +17,82 @@ "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" + } + } + } + }, + "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": { @@ -64,6 +134,82 @@ ] } }, + "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": { @@ -107,7 +253,7 @@ "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 AWS Chatbot,\nthe AWS Console Mobile Application, and emails (notifications-contacts).
", + "smithy.api#documentation": "Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Chatbot,\nthe Console Mobile Application, and emails (notifications-contacts).
The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.
\nSupported ARNs include AWS Chatbot, the Console Mobile Application, and notifications-contacts.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.
Supported ARNs include Chatbot, the Console Mobile Application, and notifications-contacts.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -130,7 +276,7 @@ "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "The ARN of the NotificationConfiguration to associate with the Channel.
", + "smithy.api#documentation": "The ARN of the NotificationConfiguration to associate with the\n Channel.
Associates an Account Contact with a particular ManagedNotificationConfiguration.
A unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.
Associates an additional Channel with a particular ManagedNotificationConfiguration.
Supported Channels include Chatbot, 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 Chatbot, 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.
Creates an EventRule that is associated with a specified Notification Configuration.
", + "smithy.api#documentation": "Creates an \n EventRule\n that\n is associated with a specified NotificationConfiguration.
The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration associated\n with this EventRule.
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
The matched event source.
\nMust 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.
The event type to match.
\nMust match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
", + "smithy.api#documentation": "The event type to match.
\nMust 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.
\nFor more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n
" + "smithy.api#documentation": "An additional event pattern used to further filter the events this\n EventRule receives.
For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n
" } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { - "smithy.api#documentation": "A list of AWS Regions that send events to this EventRule.
", + "smithy.api#documentation": "A list of Amazon Web Services Regions that send events to this\n EventRule.
The ARN of a NotificationConfiguration.
", + "smithy.api#documentation": "The ARN of a NotificationConfiguration.
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
", + "smithy.api#documentation": "A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
Creates a new NotificationConfiguration.
", + "smithy.api#documentation": "Creates a new NotificationConfiguration.
The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
", + "smithy.api#documentation": "The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
The description of the NotificationConfiguration.
", + "smithy.api#documentation": "The description of the NotificationConfiguration.
The aggregation preference of the NotificationConfiguration.
\nValues:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nNo delay in delivery.
\nThe aggregation preference of the NotificationConfiguration.
Values:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nThe Amazon Resource Name (ARN) of the the resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration.
The status of this NotificationConfiguration.
\nThe status should always be INACTIVE when part of the CreateNotificationConfiguration response.
Values:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted.
\nOnly GET and LIST calls can be run.
The current status of this NotificationConfiguration.
Deletes an EventRule.
", + "smithy.api#documentation": "Deletes an EventRule.
The Amazon Resource Name (ARN) of the EventRule to delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EventRule to delete.
Deletes a NotificationConfiguration.
", + "smithy.api#documentation": "Deletes a NotificationConfiguration.
The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration to\n delete.
Deregisters a NotificationHub in the specified Region.
\nYou can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationHub are no longer be visible. Recreating a new NotificationHub in the same Region restores access to those NotificationEvents.
\nDeregisters a NotificationConfiguration in the specified Region.
You can't deregister the last NotificationHub in the account.\n NotificationEvents stored in the deregistered NotificationConfiguration are no\n longer be visible. Recreating a new NotificationConfiguration in the same Region restores access\n to those NotificationEvents.
The NotificationHub Region.
", + "smithy.api#documentation": "The NotificationConfiguration Region.
The NotificationHub Region.
", + "smithy.api#documentation": "The NotificationConfiguration Region.
NotificationHub status information.
", + "smithy.api#documentation": "\n NotificationConfiguration status information.
Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
", + "smithy.api#documentation": "Disables service trust between User Notifications and Amazon Web Services Organizations.
", "smithy.api#http": { "code": 200, - "method": "POST", - "uri": "/channels/disassociate/{arn}" + "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 Chatbot, the Console Mobile Application, and emails (notifications-contacts).
The ARN of the NotificationConfiguration to disassociate.
", + "smithy.api#documentation": "The ARN of the NotificationConfiguration to disassociate.
Disassociates an Account Contact with a particular ManagedNotificationConfiguration.
The unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.
Disassociates an additional Channel from a particular ManagedNotificationConfiguration.
Supported Channels include Chatbot, 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.
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#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" }, @@ -830,20 +1442,20 @@ "status": { "target": "com.amazonaws.notifications#EventRuleStatus", "traits": { - "smithy.api#documentation": "The status of the EventRule.
\nValues:
\n\n ACTIVE\n
The EventRule can process events.
\n\n INACTIVE\n
The EventRule may be unable to process events.
\n\n CREATING\n
The EventRule is being created.
\nOnly GET and LIST calls can be run.
\n UPDATING\n
The EventRule is being updated.
\nOnly GET and LIST calls can be run.
\n DELETING\n
The EventRule is being deleted.
\nOnly GET and LIST calls can be run.
The status of the EventRule.
Values:
\n\n ACTIVE\n
The EventRule can process events.
\n INACTIVE\n
The EventRule may be unable to process events.
\n CREATING\n
The EventRule is being created.
Only GET and LIST calls can be run.
\n UPDATING\n
The EventRule is being updated.
Only GET and LIST calls can be run.
\n DELETING\n
The EventRule is being deleted.
Only GET and LIST calls can be run.
A human-readable reason for EventRuleStatus.
", + "smithy.api#documentation": "A human-readable reason for EventRuleStatus.
Describes EventRule status information.
" + "smithy.api#documentation": "Provides additional information about the current EventRule status.
The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and\n then uses this ARN to associate with the NotificationConfiguration.
The ARN for the NotificationConfiguration associated with this EventRule.
", + "smithy.api#documentation": "The ARN for the NotificationConfiguration associated with this EventRule.
The creation time of the resource.
", + "smithy.api#documentation": "The creation time of the EventRule.
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
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. \n For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the \n Amazon EventBridge User Guide.
The event type to match.
\nMust match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
", + "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 \n 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.
\nFor more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n
", + "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.\n
", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { - "smithy.api#documentation": "A list of AWS Regions that send events to this EventRule.
", + "smithy.api#documentation": "A list of Amazon Web Services Regions that send events to this EventRule.
A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.
\nThese are created by AWS User Notifications within your account so your EventRules can function.
\nA 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.
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
", + "smithy.api#documentation": "A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
Contains a complete list of fields related to an EventRule.
" + "smithy.api#documentation": "Contains a complete list of fields related to an EventRule.
Returns a specified EventRule.
", + "smithy.api#documentation": "Returns a specified EventRule.
The Amazon Resource Name (ARN) of the EventRule to return.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EventRule to return.
The ARN of a NotificationConfiguration.
", + "smithy.api#documentation": "The ARN of a NotificationConfiguration.
The date when the EventRule was created.
", + "smithy.api#documentation": "The date when the EventRule was created.
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
The matched event source.
\nMust 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.
The event type to match.
\nMust match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
", + "smithy.api#documentation": "The event type to match.
\nMust 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.
\nFor more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n
", + "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.\n
", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { - "smithy.api#documentation": "A list of AWS Regions that send events to this EventRule.
", + "smithy.api#documentation": "A list of Amazon Web Services Regions that send events to this EventRule.
A list of managed rules from EventBridge that are are associated with this EventRule.
\nThese are created by AWS User Notifications within your account so this EventRule functions.
\nA list of managed rules from EventBridge that are associated with this\n EventRule.
These are created by User Notifications within your account so this EventRule functions.
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
", + "smithy.api#documentation": "A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
Returns a specified NotificationConfiguration.
", + "smithy.api#documentation": "Returns the child event of a specific given ManagedNotificationEvent.
The Amazon Resource Name (ARN) of the NotificationConfiguration to return.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent to return.
The locale code of the language used for the retrieved ManagedNotificationChildEvent. The default locale is English en_US.
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", + "managedNotificationConfigurationArn": { + "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { - "smithy.api#documentation": "The status of this NotificationConfiguration.
\nThe status should always be INACTIVE when part of the CreateNotificationConfiguration response.
Values:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted. Only GET and LIST calls can be run.
Only GET and LIST calls can be run.
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration associated with the ManagedNotificationChildEvent.
The creation time of the NotificationConfiguration.
", + "smithy.api#documentation": "The creation time of the ManagedNotificationChildEvent.
The aggregation preference of the NotificationConfiguration.
\nValues:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nNo delay in delivery.
\nThe content of the ManagedNotificationChildEvent.
Returns a specified NotificationEvent.
\nUser 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.\n\t 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. \n\t For more information, see Notification hubs in the AWS User Notifications User Guide.
\nReturns a specified ManagedNotificationConfiguration.
The Amazon Resource Name (ARN) of the NotificationEvent to return.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to return.
The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.
The ARN of the resource.
", + "smithy.api#documentation": "The ARN of the ManagedNotificationConfiguration resource.
The ARN of the NotificationConfiguration.
", + "smithy.api#documentation": "The name of the ManagedNotificationConfiguration.
The creation time of the NotificationEvent.
", + "smithy.api#documentation": "The description of the ManagedNotificationConfiguration.
The content of the NotificationEvent.
", + "smithy.api#documentation": "The category of the ManagedNotificationConfiguration.
The subCategory of the ManagedNotificationConfiguration.
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" + "smithy.api#output": {} } }, - "com.amazonaws.notifications#ListChannels": { + "com.amazonaws.notifications#GetManagedNotificationEvent": { "type": "operation", "input": { - "target": "com.amazonaws.notifications#ListChannelsRequest" + "target": "com.amazonaws.notifications#GetManagedNotificationEventRequest" }, "output": { - "target": "com.amazonaws.notifications#ListChannelsResponse" + "target": "com.amazonaws.notifications#GetManagedNotificationEventResponse" }, "errors": [ { @@ -1327,50 +1910,33 @@ "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { - "documentation": "Grants permission to list Channels by NotificationConfiguration" + "documentation": "Grants permission to get a Managed NotificationEvent" }, - "smithy.api#documentation": "Returns a list of Channels for a NotificationConfiguration.
", + "smithy.api#documentation": "Returns a specified ManagedNotificationEvent.
The Amazon Resource Name (ARN) of the NotificationConfiguration.
", - "smithy.api#httpQuery": "notificationConfigurationArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ManagedNotificationEvent to return.
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", + "locale": { + "target": "com.amazonaws.notifications#LocaleCode", "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" + "smithy.api#documentation": "The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).
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#documentation": "The ARN of the resource.
", + "smithy.api#required": {} } }, - "channels": { - "target": "com.amazonaws.notifications#Channels", + "managedNotificationConfigurationArn": { + "target": "com.amazonaws.notifications#ManagedNotificationConfigurationOsArn", "traits": { - "smithy.api#documentation": "A list of Channels.
", + "smithy.api#documentation": "The ARN of the ManagedNotificationConfiguration.
The creation time of the ManagedNotificationEvent.
The content of the ManagedNotificationEvent.
Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
", + "smithy.api#documentation": "Returns a specified NotificationConfiguration.
The Amazon Resource Name (ARN) of the NotificationConfiguration.
", - "smithy.api#httpQuery": "notificationConfigurationArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration to return.
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": { + "com.amazonaws.notifications#GetNotificationConfigurationResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.notifications#NextToken", + "arn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", "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#documentation": "The ARN of the resource.
", + "smithy.api#required": {} } }, - "eventRules": { - "target": "com.amazonaws.notifications#EventRules", + "name": { + "target": "com.amazonaws.notifications#NotificationConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the NotificationConfiguration.
The description of the NotificationConfiguration.
The status of this NotificationConfiguration.
A list of EventRules.
", + "smithy.api#documentation": "The creation time of the NotificationConfiguration.
The aggregation preference of the NotificationConfiguration.
Values:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nReturns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
", + "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.\n\t 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. \n\t For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
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.
\nValues:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted.
\nOnly GET and LIST calls can be run.
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 - } + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationEvent to return.
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.
A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
" + "arn": { + "target": "com.amazonaws.notifications#NotificationEventArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#required": {} } }, - "notificationConfigurations": { - "target": "com.amazonaws.notifications#NotificationConfigurations", + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the NotificationConfiguration.
The NotificationConfigurations in the account.
", + "smithy.api#documentation": "The creation time of the NotificationEvent.
The content of the NotificationEvent.
Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).
\nUser 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.\n\t 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.\n\t For more information, see Notification hubs in the AWS User Notifications User Guide.
\nReturns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/notification-events" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "notificationEvents" + "uri": "/organization/access" }, - "smithy.api#readonly": {}, - "smithy.test#smokeTests": [ - { - "id": "ListNotificationEventsSuccess", - "params": { - "includeChildEvents": true, - "maxResults": 3 - }, - "expect": { - "success": {} - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "vendorParams": { - "region": "us-east-1" - } - } - ] + "smithy.api#readonly": {} } }, - "com.amazonaws.notifications#ListNotificationEventsRequest": { + "com.amazonaws.notifications#GetNotificationsAccessForOrganizationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.notifications#GetNotificationsAccessForOrganizationResponse": { "type": "structure", "members": { - "startTime": { - "target": "smithy.api#Timestamp", + "notificationsAccessForOrganization": { + "target": "com.amazonaws.notifications#NotificationsAccessForOrganization", "traits": { - "smithy.api#documentation": "The earliest time of events to return from this call.
", - "smithy.api#httpQuery": "startTime", - "smithy.api#timestampFormat": "date-time" + "smithy.api#documentation": "The AccessStatus of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.
Latest time of events to return from this call.
", - "smithy.api#httpQuery": "endTime", - "smithy.api#timestampFormat": "date-time" + "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" }, - "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).
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
Include aggregated child events in the result.
", - "smithy.api#httpQuery": "includeChildEvents" - } + { + "target": "com.amazonaws.notifications#ThrottlingException" }, - "aggregateNotificationEventArn": { - "target": "com.amazonaws.notifications#NotificationEventArn", + { + "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.
The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
", - "smithy.api#httpQuery": "aggregateNotificationEventArn" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration.
The maximum number of results to be returned in this call. Defaults to 20.
", + "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, @@ -1744,7 +2333,7 @@ "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#documentation": "The start token for paginated calls. Retrieved from the response of a previous\n ListNotificationEvents call. NextToken uses Base64 encoding.
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", + "channels": { + "target": "com.amazonaws.notifications#Channels", "traits": { - "smithy.api#documentation": "The list of notification events.
", + "smithy.api#documentation": "A list of Channels.
", "smithy.api#required": {} } } @@ -1774,13 +2363,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.notifications#ListNotificationHubs": { + "com.amazonaws.notifications#ListEventRules": { "type": "operation", "input": { - "target": "com.amazonaws.notifications#ListNotificationHubsRequest" + "target": "com.amazonaws.notifications#ListEventRulesRequest" }, "output": { - "target": "com.amazonaws.notifications#ListNotificationHubsResponse" + "target": "com.amazonaws.notifications#ListEventRulesResponse" }, "errors": [ { @@ -1789,6 +2378,9 @@ { "target": "com.amazonaws.notifications#InternalServerException" }, + { + "target": "com.amazonaws.notifications#ResourceNotFoundException" + }, { "target": "com.amazonaws.notifications#ThrottlingException" }, @@ -1799,56 +2391,49 @@ "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { - "documentation": "Grants permission to list NotificationHubs" + "documentation": "Grants permission to list EventRules" }, - "smithy.api#documentation": "Returns a list of NotificationHubs.
", + "smithy.api#documentation": "Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
The Amazon Resource Name (ARN) of the NotificationConfiguration.
The maximum number of records to list in a single response.
", + "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": 3, - "max": 3 + "min": 1, + "max": 1000 } } }, "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#documentation": "The start token for paginated calls. Retrieved from the response of a previous\n ListEventRules call. Next token uses Base64 encoding.
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.
" } + }, + "eventRules": { + "target": "com.amazonaws.notifications#EventRules", + "traits": { + "smithy.api#documentation": "A list of EventRules.
Returns a list of tags for a specified Amazon Resource Name (ARN).
\nFor more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
\nThis is only supported for NotificationConfigurations.
\nReturns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.
The Amazon Resource Name (ARN) to use to list tags.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to match.
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.
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).
The Amazon Resource Name (ARN) of the ManagedNotificationEvent.
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.
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.
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" + } + } + }, + "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#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\n specified filters, in reverse chronological order (newest first).
The matched event source.
\nMust 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.
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.
Values:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted.
Only GET and LIST calls can be run.
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\n ListEventRules call. Next token uses Base64 encoding.
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.
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.\n\t 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.\n\t For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
\nThe 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).
The matched event source.
\nMust 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.
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\n match.
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\n ListEventRules call. Next token uses Base64 encoding.
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.
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.
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#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).
\nFor more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
\nThis is only supported for NotificationConfigurations.
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.
\nValues:
\n\n ACCOUNT_CONTACT\n
Delivers notifications to Account Managed contacts through the User Notification Service.
\n\n MOBILE\n
Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.
\n\n CHATBOT\n
Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).
\n\n EMAIL\n
Delivers notifications to email addresses.
\nControls whether users can modify channel associations for a notification configuration.
\nValues:
\n\n ENABLED\n
Users can associate or disassociate channels with the notification configuration.
\n\n DISABLED\n
Users cannot associate or disassociate channels with the notification configuration.
\nProvides 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#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.
\nValues:
\n\n ALERT\n
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
\n\n WARNING\n
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
\n\n ANNOUNCEMENT\n
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
\n\n INFORMATIONAL\n
A notification about informational messages. For example, recommendations, service announcements, or reminders.
\nThe assesed nature of the event.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE.
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 ManagedNotificationChildEvent is 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-z0-9]{1,63}: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.
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.
The account that related to the ManagedNotificationChildEvent.
The creation time of the ManagedNotificationChildEvent.
The content of the ManagedNotificationChildEvent.
The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this ManagedNotificationChildEvent.
The Organizational Unit Id that an AWS account belongs to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an overview and metadata for a ManagedNotificationChildEvent.
The schema version of the ManagedNotificationChildEvent.
Contains all event metadata present identically across all NotificationEvents. All fields are present in Source Events via Eventbridge.
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.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE and any call can be run.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
The Type of the event causing this notification.
\nValues:
\n\n ALERT\n
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
\n\n WARNING\n
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
\n\n ANNOUNCEMENT\n
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
\n\n INFORMATIONAL\n
A notification about informational messages. For example, recommendations, service announcements, or reminders.
\nDescribes a short summary and metadata for a ManagedNotificationChildEvent.
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.
The name of the ManagedNotificationConfiguration.
The description of the ManagedNotificationConfiguration.
Describes the basic structure and properties of a ManagedNotificationConfiguration.
Version of the ManagedNotificationEvent schema.
Unique identifier for a ManagedNotificationEvent.
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.
\nValues:
\n\n ALERT\n
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
\n\n WARNING\n
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
\n\n ANNOUNCEMENT\n
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
\n\n INFORMATIONAL\n
A notification about informational messages. For example, recommendations, service announcements, or reminders.
\nThe status of an event.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE and any call can be run.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
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.
" + } + } + }, + "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-z0-9]{1,63}: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.
The account that related to the ManagedNotificationEvent.
The creation time of the ManagedNotificationEvent.
The notifications aggregation type.
\nValues:
\n\n AGGREGATE\n
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
\n\n CHILD\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
\n NONE\n
The notification isn't aggregated.
\nThe 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.
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": { - "smithy.api#input": {} + "aws.api#arn": { + "template": "{arn}", + "absolute": true + } } }, - "com.amazonaws.notifications#ListTagsForResourceResponse": { + "com.amazonaws.notifications#ManagedNotificationEventSummary": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.notifications#TagMap", + "schemaVersion": { + "target": "com.amazonaws.notifications#SchemaVersion", "traits": { - "smithy.api#documentation": "A list of tags for the specified ARN.
" + "smithy.api#documentation": "The schema version of the ManagedNotificationEvent.
Contains metadata about the event that caused the ManagedNotificationEvent.
The managed notification event status.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE.
The Type of event causing the notification.
\nValues:
\n\n ALERT\n
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
\n\n WARNING\n
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
\n\n ANNOUNCEMENT\n
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
\n\n INFORMATIONAL\n
A notification about informational messages. For example, recommendations, service announcements, or reminders.
\nA short summary of a ManagedNotificationEvent. This is only used when listing managed notification events.
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.
\nMust 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.
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": { @@ -2070,7 +4167,7 @@ "url": { "target": "com.amazonaws.notifications#Url", "traits": { - "smithy.api#documentation": "The url of the media.
", + "smithy.api#documentation": "The URL of the media.
", "smithy.api#required": {} } }, @@ -2118,7 +4215,7 @@ "paragraphSummary": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { - "smithy.api#documentation": "A paragraph long or multiple sentence summary. For example, AWS Chatbot notifications.
" + "smithy.api#documentation": "A paragraph long or multiple sentence summary. For example, Chatbot notifications.
" } }, "completeDescription": { @@ -2260,42 +4357,42 @@ "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NotificationConfiguration\n resource.
The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
", + "smithy.api#documentation": "The name of the NotificationConfiguration. Supports RFC 3986's\n unreserved characters.
The description of the NotificationConfiguration.
", + "smithy.api#documentation": "The description of the NotificationConfiguration.
The status of this NotificationConfiguration.
\nThe status should always be INACTIVE when part of the CreateNotificationConfiguration response.
\nValues:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted. Only GET and LIST calls can be run.
Only GET and LIST calls can be run.
The current status of the NotificationConfiguration.
The creation time of the resource.
", + "smithy.api#documentation": "The creation time of the NotificationConfiguration.
The aggregation preference of the NotificationConfiguration.
\nValues:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nNo delay in delivery.
\nThe aggregation preference of the NotificationConfiguration.
Values:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nThe ARN of the NotificationConfiguration.
", + "smithy.api#documentation": "The ARN of the NotificationConfiguration.
The account name containing the NotificationHub.
", + "smithy.api#documentation": "The account name containing the NotificationHub.
The creation time of the NotificationEvent.
", + "smithy.api#documentation": "The creation time of the NotificationEvent.
Refers to a NotificationEventSummary object.
\nSimilar in structure to content in the GetNotificationEvent response.
Refers to a NotificationEventSummary object.
Similar in structure to content in the GetNotificationEvent response.
The NotificationConfiguration's aggregation type.
\nValues:
\n\n AGGREGATE\n
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
\n\n CHILD\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
\n NONE\n
The notification isn't aggregated.
\nThe NotificationConfiguration's aggregation type.
Values:
\n\n AGGREGATE\n
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
\n\n CHILD\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
\n NONE\n
The notification isn't aggregated.
\nThe ARN of the aggregatedNotificationEventArn to match.
" + "smithy.api#documentation": "The ARN of the aggregatedNotificationEventArn to match.
Provides an aggregated summary data for notification events.
" } } }, "traits": { - "smithy.api#documentation": "Describes a short summary of a NotificationEvent. This is only used when listing notification events.
" + "smithy.api#documentation": "Describes a short summary of a NotificationEvent. This is only used when listing notification events.
The unique identifier for a NotificationEvent.
", + "smithy.api#documentation": "The unique identifier for a NotificationEvent.
The assesed nature of the event.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE and any call can be run.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
The assessed nature of the event.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE and any call can be run.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
The NotificationConfiguration's aggregation type.
\nValues:
\n\n AGGREGATE\n
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
\n\n CHILD\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
\n NONE\n
The notification isn't aggregated.
\nThe aggregation type of the NotificationConfiguration.
Values:
\n\n AGGREGATE\n
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
\n\n CHILD\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
\n NONE\n
The notification isn't aggregated.
\nIf 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.
" + "smithy.api#documentation": "If the value of aggregationEventType is not NONE, this is the\n 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": { @@ -2497,7 +4606,7 @@ } }, "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.
" + "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.
The notification event status.
\nValues:
\n\n HEALTHY\n
All EventRules are ACTIVE and any call can be run.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Provides additional information about the current status of the NotificationEvent.
Values:
\n\n HEALTHY\n
All EventRules are ACTIVE.
\n UNHEALTHY\n
Some EventRules are ACTIVE and some are INACTIVE.
Describes a short summary and metadata for a notification event.
" + "smithy.api#documentation": "Describes a short summary and metadata for a NotificationEvent.
The date and time the resource was created.
", + "smithy.api#documentation": "The date and time the NotificationHubOverview was created.
The most recent time this NotificationHub had an ACTIVE status.
" + "smithy.api#documentation": "The most recent time this NotificationHub had an ACTIVE status.
Describes an overview of a NotificationHub.
\nA NotificationHub is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.
" + "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.
Status information about the NotificationHub.
\nValues:
\n\n ACTIVE\n
Incoming NotificationEvents are replicated to this NotificationHub.
\n\n REGISTERING\n
The NotificationHub is initializing. A NotificationHub with this status can't be deregistered.
\n\n DEREGISTERING\n
The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub with this status.
\nStatus information about the NotificationHub.
Values:
\n\n ACTIVE\n
Incoming NotificationEvents are replicated to this\n NotificationHub.
\n REGISTERING\n
The NotificationConfiguration is initializing. A NotificationConfiguration with this status can't be deregistered.
\n DEREGISTERING\n
The NotificationConfiguration is being deleted. You can't register additional\n NotificationHubs in the same Region as a\n NotificationConfiguration with this status.
An Explanation for the current status.
", + "smithy.api#documentation": "An explanation for the current status.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "NotificationHub status information.
" + "smithy.api#documentation": "Provides additional information about the current NotificationHub status.
The AWS User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.
\nUser Notification control APIs are currently available in US East (Virginia) - us-east-1.
\n GetNotificationEvent\n\t and ListNotificationEvents APIs are currently available in\n\t commercial partition Regions and only return notifications stored in the same Region in which they're called.
\nThe User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a \n\t notification hub in addition to US East (Virginia).
", + "smithy.api#documentation": "The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.
\nUser Notification control plane APIs are currently available in US East (Virginia) - us-east-1.
\n GetNotificationEvent\n\t and ListNotificationEvents APIs are currently available in\n\t commercial partition Regions and only return notifications stored in the same Region in which they're called.
\nThe User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a \n\t notification hub in addition to US East (Virginia).
", "smithy.api#title": "AWS User Notifications", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3095,6 +5225,39 @@ } } }, + "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#OrganizationalUnitId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^Root|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + } + }, "com.amazonaws.notifications#QuotaCode": { "type": "string" }, @@ -3152,7 +5315,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to register a NotificationHub" }, - "smithy.api#documentation": "Registers a NotificationHub in the specified Region.
\nThere is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.
", + "smithy.api#documentation": "Registers a NotificationConfiguration in the specified Region.
There is a maximum of one NotificationConfiguration per Region. You can have a\n maximum of 3 NotificationHub resources at a time.
The Region of the NotificationHub.
", + "smithy.api#documentation": "The Region of the NotificationHub.
The Region of the NotificationHub.
", + "smithy.api#documentation": "The Region of the NotificationHub.
NotificationHub status information.
", + "smithy.api#documentation": "Provides additional information about the current NotificationConfiguration\n status information.
The Primary AWS account of Source Event
", + "smithy.api#documentation": "The primary Amazon Web Services account of SourceEvent.
The AWS servvice the event originates from. For example aws.cloudwatch.
The Amazon Web Services service the event originates from. For example aws.cloudwatch.
The type of event. For example, an AWS CloudWatch state change.
", + "smithy.api#documentation": "The type of event. For example, an Amazon CloudWatch state change.
", "smithy.api#length": { "min": 1, "max": 256 @@ -3411,7 +5591,7 @@ "relatedResources": { "target": "com.amazonaws.notifications#Resources", "traits": { - "smithy.api#documentation": "A list of resources related to this NotificationEvent.
", + "smithy.api#documentation": "A list of resources related to this NotificationEvent.
The matched event source.
\nMust match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
The matched event source.
\nMust 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.
The event type to match.
\nMust match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
", + "smithy.api#documentation": "The event type to match.
\nMust 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 @@ -3452,7 +5632,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata about the event that caused the NotificationEvent. For other specific values, see sourceEventMetadata.
" + "smithy.api#documentation": "Contains metadata about the event that caused the NotificationEvent. For\n other specific values, see sourceEventMetadata.
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": { @@ -3527,7 +5769,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to tag a resource" }, - "smithy.api#documentation": "Tags the resource with a tag key and value.
\nFor more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
\nThis is only supported for NotificationConfigurations.
\nTags the resource with a tag key and value.
\nFor more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
\nThis is only supported for NotificationConfigurations.
A short single line description of the link. Must be hyperlinked with the URL itself.
\nUsed for text parts with the type URL.
A short single line description of the link. Must be hyper-linked with the URL itself.
\nUsed for text parts with the type URL.
Untags a resource with a specified Amazon Resource Name (ARN).
\nFor more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
", + "smithy.api#documentation": "Untags a resource with a specified Amazon Resource Name (ARN).
\nFor 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}" @@ -3818,7 +6060,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update an EventRule" }, - "smithy.api#documentation": "Updates an existing EventRule.
", + "smithy.api#documentation": "Updates an existing EventRule.
The Amazon Resource Name (ARN) to use to update the EventRule.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) to use to update the EventRule.
An additional event pattern used to further filter the events this EventRule receives.
\nFor more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n
" + "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.\n
" } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { - "smithy.api#documentation": "A list of AWS Regions that sends events to this EventRule.
" + "smithy.api#documentation": "A list of Amazon Web Services Regions that sends events to this EventRule.
The Amazon Resource Name (ARN) to use to update the EventRule.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) to use to update the EventRule.
The ARN of the NotificationConfiguration.
", + "smithy.api#documentation": "The ARN of the NotificationConfiguration.
Updates a NotificationConfiguration.
", + "smithy.api#documentation": "Updates a NotificationConfiguration.
The Amazon Resource Name (ARN) used to update the NotificationConfiguration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) used to update the NotificationConfiguration.
The name of the NotificationConfiguration.
" + "smithy.api#documentation": "The name of the NotificationConfiguration.
The description of the NotificationConfiguration.
" + "smithy.api#documentation": "The description of the NotificationConfiguration.
The status of this NotificationConfiguration.
\nThe status should always be INACTIVE when part of the CreateNotificationConfiguration response.
Values:
\n\n ACTIVE\n
All EventRules are ACTIVE and any call can be run.
\n PARTIALLY_ACTIVE\n
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Any call can be run.
\n\n INACTIVE\n
All EventRules are INACTIVE and any call can be run.
\n DELETING\n
This NotificationConfiguration is being deleted.
\nOnly GET and LIST calls can be run.
The aggregation preference of the NotificationConfiguration.
Values:
\n\n LONG\n
Aggregate notifications for long periods of time (12 hours).
\n\n SHORT\n
Aggregate notifications for short periods of time (5 minutes).
\n\n NONE\n
Don't aggregate notifications.
\nThe ARN used to update the NotificationConfiguration.
", + "smithy.api#documentation": "The ARN used to update the NotificationConfiguration.
The Amazon EC2 Container Registry path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.