Returns current default log-levels, or log levels by resource types, could be for wireless device log options or wireless gateway log options.
" + "documentation":"Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.
" }, "GetPartnerAccount":{ "name":"GetPartnerAccount", @@ -501,7 +501,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Fetches the log-level override if any for a given resource-ID and resource-type, coulde be a wireless device or a wireless gateway.
" + "documentation":"Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
" }, "GetServiceEndpoint":{ "name":"GetServiceEndpoint", @@ -819,7 +819,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Sets the log-level override for a resource-ID and resource-type, could be a wireless gateway or a wireless device.
" + "documentation":"Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.
" }, "ResetAllResourceLogLevels":{ "name":"ResetAllResourceLogLevels", @@ -837,7 +837,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Remove log-level overrides if any for all resources (both wireless devices and wireless gateways).
" + "documentation":"Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
" }, "ResetResourceLogLevel":{ "name":"ResetResourceLogLevel", @@ -855,7 +855,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Remove log-level override if any for a specific resource-ID and resource-type, could be a wireless device or a wireless gateway.
" + "documentation":"Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
" }, "SendDataToWirelessDevice":{ "name":"SendDataToWirelessDevice", @@ -963,7 +963,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Set default log level, or log levels by resource types, could be for wireless device log options or wireless gateways log options. This is to control the log messages that will be displayed in CloudWatch.
" + "documentation":"Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.
" }, "UpdatePartnerAccount":{ "name":"UpdatePartnerAccount", @@ -1061,6 +1061,7 @@ "AddGwMetadata":{"type":"boolean"}, "AmazonId":{ "type":"string", + "documentation":"The Sidewalk Amazon ID.
", "max":2048 }, "AmazonResourceName":{ @@ -2082,7 +2083,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"The type of the resource, currently support WirelessDevice and WirelessGateway.
", + "documentation":"The type of the resource, which can be WirelessDevice or WirelessGateway.
Sidewalk device message type.
", + "documentation":"Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.
The type of the resource, currently support WirelessDevice and WirelessGateway.
", + "documentation":"The type of the resource, which can be WirelessDevice or WirelessGateway.
The type of the resource, currently support WirelessDevice and WirelessGateway.
", + "documentation":"The type of the resource, which can be WirelessDevice or WirelessGateway.
The identifier of the resource. For a Wireless Device, it is the wireless device id. For a wireless gateway, it is the wireless gateway id.
", + "documentation":"The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
", "max":256 }, "ResourceNotFoundException":{ @@ -3435,7 +3436,7 @@ }, "PayloadData":{ "shape":"PayloadData", - "documentation":"The message payload to send.
" + "documentation":"The binary to be sent to the end device, encoded in base64.
" }, "WirelessMetadata":{ "shape":"WirelessMetadata", @@ -3563,6 +3564,7 @@ "SidewalkDevice":{ "type":"structure", "members":{ + "AmazonId":{"shape":"AmazonId"}, "SidewalkId":{ "shape":"SidewalkId", "documentation":"The sidewalk device identification.
" @@ -4055,7 +4057,7 @@ "Event":{"shape":"WirelessDeviceEvent"}, "LogLevel":{"shape":"LogLevel"} }, - "documentation":"The log option for a wireless device event. Can be used to set log level for a specific wireless device event. For a LoRaWAN device, the possible events for a log messsage are: Join, Rejoin, Downlink_Data, Uplink_Data. For a Sidewalk device, the possible events for a log message are: Registration, Downlink_Data, Uplink_Data.
" + "documentation":"The log options for a wireless device event and can be used to set log levels for a specific wireless device event.
For a LoRaWAN device, possible events for a log messsage are: Join, Rejoin, Downlink_Data, and Uplink_Data. For a Sidewalk device, possible events for a log message are Registration, Downlink_Data, and Uplink_Data.
The log option for wireless devices. Can be used to set log level for a specific type of wireless device.
" + "documentation":"The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
" }, "WirelessDeviceLogOptionList":{ "type":"list", @@ -4167,7 +4170,7 @@ "Event":{"shape":"WirelessGatewayEvent"}, "LogLevel":{"shape":"LogLevel"} }, - "documentation":"The log option for a wireless gateway event. Can be used to set log level for a specific wireless gateway event. For a LoRaWAN gateway, the possible events for a log message are: CUPS_Request, Certificate.
" + "documentation":"The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.
For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate.
The log option for wireless gateways. Can be used to set log level for a specific type of wireless gateway.
" + "documentation":"The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
" }, "WirelessGatewayLogOptionList":{ "type":"list", From 16e198379b56b10e09dc37f050069c61b48b4b8b Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:53 +0000 Subject: [PATCH 03/14] Amazon QuickSight Update: Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight --- .../feature-AmazonQuickSight-5e5ea2b.json | 6 + .../codegen-resources/service-2.json | 966 ++++++++++++------ 2 files changed, 654 insertions(+), 318 deletions(-) create mode 100644 .changes/next-release/feature-AmazonQuickSight-5e5ea2b.json diff --git a/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json b/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json new file mode 100644 index 000000000000..29d9d5c96507 --- /dev/null +++ b/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon QuickSight", + "contributor": "", + "description": "Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight" +} diff --git a/services/quicksight/src/main/resources/codegen-resources/service-2.json b/services/quicksight/src/main/resources/codegen-resources/service-2.json index fe4cd856030c..0a923fb011b1 100644 --- a/services/quicksight/src/main/resources/codegen-resources/service-2.json +++ b/services/quicksight/src/main/resources/codegen-resources/service-2.json @@ -46,7 +46,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Creates Amazon QuickSight customizations the current Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account; or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
" + "documentation":"Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account;.
" }, "CreateDataSet":{ "name":"CreateDataSet", @@ -225,7 +225,7 @@ {"shape":"ConcurrentUpdatingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
" + "documentation":"Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account;. To avoid overwriting rules in other namespaces, use assignment names that are unique.
" }, "CreateIngestion":{ "name":"CreateIngestion", @@ -244,7 +244,7 @@ {"shape":"ResourceExistsException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
" + "documentation":"Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
" }, "CreateNamespace":{ "name":"CreateNamespace", @@ -266,7 +266,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
" + "documentation":"(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account; is subscribed to QuickSight. The namespace must be unique within the Amazon Web Services account;. By default, there is a limit of 100 namespaces per Amazon Web Services account;. To increase your limit, create a ticket with Amazon Web Services Support.
" }, "CreateTemplate":{ "name":"CreateTemplate", @@ -287,7 +287,7 @@ {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
" + "documentation":"Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
" }, "CreateTemplateAlias":{ "name":"CreateTemplateAlias", @@ -365,7 +365,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
" + "documentation":"Deletes all Amazon QuickSight customizations in this Region; for the specified Amazon Web Services account; and QuickSight namespace.
" }, "DeleteAnalysis":{ "name":"DeleteAnalysis", @@ -641,7 +641,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
" + "documentation":"Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
" }, "DeleteUserByPrincipalId":{ "name":"DeleteUserByPrincipalId", @@ -678,7 +678,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace.
To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.
Describes the customizations associated with the provided Amazon Web Services account; and Amazon QuickSight namespace in an Region;. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account; - The Amazon Web Services account; exists at the top of the hierarchy. It has the potential to use all of the Regions; and AWS Services. When you subscribe to QuickSight, you choose one Region; to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported Region;.
Region; - In each Region; where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any Region;, unless they are constrained to a namespace.
To run the command in a different Region;, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Region;. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account; and Region;.
Applied customizations - Within an Region;, a set of QuickSight customizations can apply to an Amazon Web Services account; or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account;. All settings are isolated to a single Region;. To apply them in other Regions;, run the CreateAccountCustomization command in each Region; where you want to apply the same customizations.
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
" + "documentation":"Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account;.
" }, "DescribeAnalysis":{ "name":"DescribeAnalysis", @@ -1091,6 +1091,47 @@ ], "documentation":"Returns information about a user, given the user name.
" }, + "GenerateEmbedUrlForAnonymousUser":{ + "name":"GenerateEmbedUrlForAnonymousUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/embed-url/anonymous-user" + }, + "input":{"shape":"GenerateEmbedUrlForAnonymousUserRequest"}, + "output":{"shape":"GenerateEmbedUrlForAnonymousUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"SessionLifetimeInMinutesInvalidException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"UnsupportedPricingPlanException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + }, + "GenerateEmbedUrlForRegisteredUser":{ + "name":"GenerateEmbedUrlForRegisteredUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/embed-url/registered-user" + }, + "input":{"shape":"GenerateEmbedUrlForRegisteredUserRequest"}, + "output":{"shape":"GenerateEmbedUrlForRegisteredUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"QuickSightUserNotFoundException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"SessionLifetimeInMinutesInvalidException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"UnsupportedPricingPlanException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + }, "GetDashboardEmbedUrl":{ "name":"GetDashboardEmbedUrl", "http":{ @@ -1113,7 +1154,7 @@ {"shape":"UnsupportedPricingPlanException"}, {"shape":"InternalFailureException"} ], - "documentation":"Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
" + "documentation":"Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" }, "GetSessionEmbedUrl":{ "name":"GetSessionEmbedUrl", @@ -1150,7 +1191,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists Amazon QuickSight analyses that exist in the specified AWS account.
" + "documentation":"Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account;.
" }, "ListDashboardVersions":{ "name":"ListDashboardVersions", @@ -1184,7 +1225,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists dashboards in an AWS account.
" + "documentation":"Lists dashboards in an Amazon Web Services account;.
" }, "ListDataSets":{ "name":"ListDataSets", @@ -1201,7 +1242,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists all of the datasets belonging to the current Amazon Web Services account; in an Region;.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists data sources in current AWS Region that belong to this AWS account.
" + "documentation":"Lists data sources in current Region; that belong to this Amazon Web Services account;.
" }, "ListFolderMembers":{ "name":"ListFolderMembers", @@ -1372,7 +1413,7 @@ {"shape":"InternalFailureException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Lists the namespaces for the specified AWS account.
" + "documentation":"Lists the namespaces for the specified Amazon Web Services account;.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -1480,7 +1521,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all the versions of the themes in the current AWS account.
" + "documentation":"Lists all the versions of the themes in the current Amazon Web Services account;.
" }, "ListThemes":{ "name":"ListThemes", @@ -1499,7 +1540,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Lists all the themes in the current AWS account.
" + "documentation":"Lists all the themes in the current Amazon Web Services account;.
" }, "ListUserGroups":{ "name":"ListUserGroups", @@ -1595,7 +1636,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"InternalFailureException"} ], - "documentation":"Searches for analyses that belong to the user specified in the filter.
" + "documentation":"Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Searches for dashboards that belong to a user.
" + "documentation":"Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for Resource Groups.
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates Amazon QuickSight customizations the current Region;. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account; or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates the Amazon QuickSight settings in your AWS account.
" + "documentation":"Updates the Amazon QuickSight settings in your Amazon Web Services account;.
" }, "UpdateAnalysis":{ "name":"UpdateAnalysis", @@ -1759,7 +1800,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates a dashboard in an AWS account.
" + "documentation":"Updates a dashboard in an Amazon Web Services account;.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
", @@ -2103,14 +2144,14 @@ "documentation":"The default theme for this QuickSight subscription.
" } }, - "documentation":"The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
" + "documentation":"The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Region;.
" }, "AccountSettings":{ "type":"structure", "members":{ "AccountName":{ "shape":"String", - "documentation":"The \"account name\" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.
" + "documentation":"The \"account name\" you provided for the QuickSight subscription in your Amazon Web Services account;. You create this name when you sign up for QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
" }, "Edition":{ "shape":"Edition", @@ -2118,14 +2159,14 @@ }, "DefaultNamespace":{ "shape":"Namespace", - "documentation":"The default QuickSight namespace for your AWS account.
" + "documentation":"The default QuickSight namespace for your Amazon Web Services account;.
" }, "NotificationEmail":{ "shape":"String", "documentation":"The main notification email for your QuickSight subscription.
" } }, - "documentation":"The QuickSight settings associated with your AWS account.
" + "documentation":"The QuickSight settings associated with your Amazon Web Services account;.
" }, "ActionList":{ "type":"list", @@ -2145,7 +2186,7 @@ "documentation":"The Amazon Resource Name (ARN) of the resource.
" } }, - "documentation":"The active AWS Identity and Access Management (IAM) policy assignment.
" + "documentation":"The active Identity and Access Management (IAM) policy assignment.
" }, "ActiveIAMPolicyAssignmentList":{ "type":"list", @@ -2338,7 +2379,7 @@ }, "Name":{ "shape":"AnalysisName", - "documentation":"The name of the analysis. This name is displayed in the QuickSight console.
" + "documentation":"The name of the analysis. This name is displayed in the QuickSight console.
" }, "Status":{ "shape":"ResourceStatus", @@ -2360,7 +2401,32 @@ "member":{"shape":"AnalysisSummary"}, "max":100 }, + "AnonymousUserDashboardEmbeddingConfiguration":{ + "type":"structure", + "required":["InitialDashboardId"], + "members":{ + "InitialDashboardId":{ + "shape":"RestrictiveResourceId", + "documentation":"The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
Information about the dashboard that you want to embed.
" + }, + "AnonymousUserEmbeddingExperienceConfiguration":{ + "type":"structure", + "members":{ + "Dashboard":{ + "shape":"AnonymousUserDashboardEmbeddingConfiguration", + "documentation":"The type of embedding experience. In this case, an Amazon QuickSight dashboard.
" + } + }, + "documentation":"The type of experience you want to embed. For anonymous users, you can embed an Amazon QuickSight dashboard.
" + }, "Arn":{"type":"string"}, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"} + }, "AssignmentStatus":{ "type":"string", "enum":[ @@ -2444,7 +2510,7 @@ "documentation":"Dataset name.
" } }, - "documentation":"AWS IoT Analytics parameters.
" + "documentation":"Amazon Web Services IoT Analytics parameters.
" }, "Boolean":{"type":"boolean"}, "BorderStyle":{ @@ -2497,7 +2563,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -2528,7 +2594,7 @@ }, "RequestId":{ "shape":"string", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -2751,7 +2817,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"Updating or deleting a resource can cause an inconsistent state.
", @@ -2771,7 +2837,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to customize QuickSight for.
", + "documentation":"The ID for the Amazon Web Services account; that you want to customize QuickSight for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -2783,7 +2849,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
The QuickSight customizations you're adding in the current Region;. You can add these to an Amazon Web Services account; and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
" + "documentation":"The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account;.
" }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to customize QuickSight for.
" + "documentation":"The ID for the Amazon Web Services account; that you want to customize QuickSight for.
" }, "Namespace":{ "shape":"Namespace", @@ -2808,11 +2874,11 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The QuickSight customizations you're adding in the current AWS Region.
" + "documentation":"The QuickSight customizations you're adding in the current Region;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -2832,7 +2898,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account where you are creating an analysis.
", + "documentation":"The ID of the Amazon Web Services account; where you are creating an analysis.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -2852,7 +2918,7 @@ }, "Permissions":{ "shape":"ResourcePermissionList", - "documentation":"A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -2916,7 +2982,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account where you want to create the dashboard.
", + "documentation":"The ID of the Amazon Web Services account; where you want to create the dashboard.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -2940,7 +3006,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
" + "documentation":"The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account; where you create the dashboard.
" } } }, @@ -2986,7 +3052,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -3002,13 +3068,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "documentation":"An ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Name":{ "shape":"ResourceName", @@ -3042,6 +3108,10 @@ "shape":"RowLevelPermissionDataSet", "documentation":"The row-level security configuration for the data that you want to create.
" }, + "RowLevelPermissionTagConfiguration":{ + "shape":"RowLevelPermissionTagConfiguration", + "documentation":"The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
" + }, "ColumnLevelPermissionRules":{ "shape":"ColumnLevelPermissionRuleList", "documentation":"A set of one or more definitions of a ColumnLevelPermissionRule .
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
" }, "IngestionArn":{ "shape":"Arn", @@ -3073,7 +3143,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3093,13 +3163,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"An ID for the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"An ID for the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Name":{ "shape":"ResourceName", @@ -3144,7 +3214,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "CreationStatus":{ "shape":"ResourceStatus", @@ -3152,7 +3222,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3299,7 +3369,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -3320,7 +3390,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3347,7 +3417,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -3369,7 +3439,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3390,13 +3460,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
", + "documentation":"The ID of the Amazon Web Services account; where you want to assign an IAM policy to QuickSight users or groups.
", "location":"uri", "locationName":"AwsAccountId" }, "AssignmentName":{ "shape":"IAMPolicyAssignmentName", - "documentation":"The name of the assignment, also called a rule. It must be unique within an AWS account.
" + "documentation":"The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account;.
" }, "AssignmentStatus":{ "shape":"AssignmentStatus", @@ -3423,7 +3493,7 @@ "members":{ "AssignmentName":{ "shape":"IAMPolicyAssignmentName", - "documentation":"The name of the assignment. This name must be unique within the AWS account.
" + "documentation":"The name of the assignment. This name must be unique within the Amazon Web Services account;.
" }, "AssignmentId":{ "shape":"String", @@ -3443,7 +3513,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3474,7 +3544,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" } @@ -3497,7 +3567,7 @@ }, "RequestId":{ "shape":"string", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3516,7 +3586,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to create the QuickSight namespace in.
", + "documentation":"The ID for the Amazon Web Services account; that you want to create the QuickSight namespace in.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -3547,7 +3617,7 @@ }, "CapacityRegion":{ "shape":"String", - "documentation":"The AWS Region that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
" + "documentation":"The Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
" }, "CreationStatus":{ "shape":"NamespaceStatus", @@ -3559,7 +3629,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -3579,7 +3649,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template that you creating an alias for.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template that you creating an alias for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -3591,7 +3661,7 @@ }, "AliasName":{ "shape":"AliasName", - "documentation":"The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by QuickSight.
The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -3629,13 +3699,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, "TemplateId":{ "shape":"RestrictiveResourceId", - "documentation":"An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
", + "documentation":"An ID for the template that you want to create. This template is unique per Region; in each Amazon Web Services account;.
", "location":"uri", "locationName":"TemplateId" }, @@ -3649,7 +3719,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -3702,7 +3772,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme for the new theme alias.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme for the new theme alias.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -3738,7 +3808,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -3754,13 +3824,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account where you want to store the new theme.
", + "documentation":"The ID of the Amazon Web Services account; where you want to store the new theme.
", "location":"uri", "locationName":"AwsAccountId" }, "ThemeId":{ "shape":"RestrictiveResourceId", - "documentation":"An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
", + "documentation":"An ID for the theme that you want to create. The theme ID is unique per Region; in each Amazon Web Services account;.
", "location":"uri", "locationName":"ThemeId" }, @@ -3816,7 +3886,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -4229,6 +4299,10 @@ "shape":"RowLevelPermissionDataSet", "documentation":"The row-level security configuration for the dataset.
" }, + "RowLevelPermissionTagConfiguration":{ + "shape":"RowLevelPermissionTagConfiguration", + "documentation":"The element you can use to define tags for row-level security.
" + }, "ColumnLevelPermissionRules":{ "shape":"ColumnLevelPermissionRuleList", "documentation":"A set of one or more definitions of a ColumnLevelPermissionRule .
The row-level security configuration for the dataset.
" }, + "RowLevelPermissionTagConfigurationApplied":{ + "shape":"Boolean", + "documentation":"Whether or not the row level permission tags are applied.
" + }, "ColumnLevelPermissionRulesApplied":{ "shape":"Boolean", "documentation":"A value that indicates if the dataset has column level permission configured.
" @@ -4360,7 +4438,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Name":{ "shape":"ResourceName", @@ -4472,7 +4550,7 @@ }, "AwsIotAnalyticsParameters":{ "shape":"AwsIotAnalyticsParameters", - "documentation":"AWS IoT Analytics parameters.
" + "documentation":"Amazon Web Services IoT Analytics parameters.
" }, "JiraParameters":{ "shape":"JiraParameters", @@ -4628,7 +4706,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.
", + "documentation":"The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in this Region;.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -4645,7 +4723,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -4663,7 +4741,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account where you want to delete an analysis.
", + "documentation":"The ID of the Amazon Web Services account; where you want to delete an analysis.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -4709,7 +4787,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -4722,7 +4800,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're deleting.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're deleting.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -4758,7 +4836,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -4771,13 +4849,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSetId" } @@ -4792,11 +4870,11 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -4814,13 +4892,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSourceId" } @@ -4835,11 +4913,11 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -4962,7 +5040,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -4979,7 +5057,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5004,7 +5082,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5021,7 +5099,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5040,7 +5118,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID where you want to delete the IAM policy assignment.
", + "documentation":"The Amazon Web Services account; ID where you want to delete the IAM policy assignment.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5067,7 +5145,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5085,7 +5163,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to delete the QuickSight namespace from.
", + "documentation":"The ID for the Amazon Web Services account; that you want to delete the QuickSight namespace from.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5102,7 +5180,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5121,7 +5199,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the item to delete.
", + "documentation":"The ID of the Amazon Web Services account; that contains the item to delete.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5161,7 +5239,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -5174,7 +5252,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template that you're deleting.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template that you're deleting.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5197,7 +5275,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Arn":{ "shape":"Arn", @@ -5224,7 +5302,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme alias to delete.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme alias to delete.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5255,7 +5333,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5277,7 +5355,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme that you're deleting.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme that you're deleting.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5304,7 +5382,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5333,7 +5411,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5351,7 +5429,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5376,7 +5454,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5393,7 +5471,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5413,7 +5491,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to describe QuickSight customizations for.
", + "documentation":"The ID for the Amazon Web Services account; that you want to describe QuickSight customizations for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5436,11 +5514,11 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
" + "documentation":"The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account;.
" }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you're describing.
" + "documentation":"The ID for the Amazon Web Services account; that you're describing.
" }, "Namespace":{ "shape":"Namespace", @@ -5448,11 +5526,11 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The QuickSight customizations that exist in the current AWS Region.
" + "documentation":"The QuickSight customizations that exist in the current Region;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5467,7 +5545,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that contains the settings that you want to list.
", + "documentation":"The ID for the Amazon Web Services account; that contains the settings that you want to list.
", "location":"uri", "locationName":"AwsAccountId" } @@ -5478,11 +5556,11 @@ "members":{ "AccountSettings":{ "shape":"AccountSettings", - "documentation":"The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
" + "documentation":"The QuickSight settings for this Amazon Web Services account;. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your Amazon Web Services account;. The edition that you subscribe to applies to QuickSight in every Region; where you use it.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5500,7 +5578,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account; that the analysis is in.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5534,7 +5612,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -5547,7 +5625,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analysis. You must be using the Amazon Web Services account; that the analysis is in.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5573,7 +5651,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -5586,7 +5664,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're describing permissions for.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're describing permissions for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5620,7 +5698,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -5633,7 +5711,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -5671,7 +5749,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -5684,13 +5762,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSetId" } @@ -5705,7 +5783,7 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -5713,7 +5791,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5731,13 +5809,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSetId" } @@ -5752,7 +5830,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5770,13 +5848,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSourceId" } @@ -5791,7 +5869,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -5799,7 +5877,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5817,13 +5895,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSourceId" } @@ -5838,7 +5916,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -5996,7 +6074,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6017,7 +6095,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6036,7 +6114,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the assignment that you want to describe.
", + "documentation":"The ID of the Amazon Web Services account; that contains the assignment that you want to describe.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6063,7 +6141,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6082,7 +6160,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6109,7 +6187,7 @@ }, "RequestId":{ "shape":"string", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6127,7 +6205,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that contains the QuickSight namespace that you want to describe.
", + "documentation":"The ID for the Amazon Web Services account; that contains the QuickSight namespace that you want to describe.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6144,11 +6222,11 @@ "members":{ "Namespace":{ "shape":"NamespaceInfoV2", - "documentation":"The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
The information about the namespace that you're describing. The response includes the namespace ARN, name, Region;, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6167,7 +6245,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template alias that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template alias that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6199,7 +6277,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -6212,7 +6290,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6241,7 +6319,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6259,7 +6337,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6297,7 +6375,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -6311,7 +6389,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme alias that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme alias that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6343,7 +6421,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -6356,7 +6434,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6385,7 +6463,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6403,7 +6481,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAndAccountId", - "documentation":"The ID of the AWS account that contains the theme that you're describing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme that you're describing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6441,7 +6519,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -6461,7 +6539,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6482,7 +6560,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -6502,7 +6580,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
", @@ -6533,6 +6611,11 @@ "type":"string", "sensitive":true }, + "EntryPath":{ + "type":"string", + "max":1000, + "min":1 + }, "EntryPoint":{ "type":"string", "max":1000, @@ -6764,6 +6847,117 @@ "type":"string", "enum":["SHARED"] }, + "GenerateEmbedUrlForAnonymousUserRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "Namespace", + "AuthorizedResourceArns", + "ExperienceConfiguration" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
", + "location":"uri", + "locationName":"AwsAccountId" + }, + "SessionLifetimeInMinutes":{ + "shape":"SessionLifetimeInMinutes", + "documentation":"How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.
" + }, + "AuthorizedResourceArns":{ + "shape":"ArnList", + "documentation":"The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.
The configuration of the experience you are embedding.
" + } + } + }, + "GenerateEmbedUrlForAnonymousUserResponse":{ + "type":"structure", + "required":[ + "EmbedUrl", + "Status", + "RequestId" + ], + "members":{ + "EmbedUrl":{ + "shape":"EmbeddingUrl", + "documentation":"The embed URL for the dashboard.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + } + } + }, + "GenerateEmbedUrlForRegisteredUserRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "UserArn", + "ExperienceConfiguration" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
", + "location":"uri", + "locationName":"AwsAccountId" + }, + "SessionLifetimeInMinutes":{ + "shape":"SessionLifetimeInMinutes", + "documentation":"How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
" + }, + "UserArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name for the registered user.
" + }, + "ExperienceConfiguration":{ + "shape":"RegisteredUserEmbeddingExperienceConfiguration", + "documentation":"The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.
" + } + } + }, + "GenerateEmbedUrlForRegisteredUserResponse":{ + "type":"structure", + "required":[ + "EmbedUrl", + "Status", + "RequestId" + ], + "members":{ + "EmbedUrl":{ + "shape":"EmbeddingUrl", + "documentation":"The embed URL for the Amazon QuickSight dashboard or console.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + } + } + }, "GeoSpatialColumnGroup":{ "type":"structure", "required":[ @@ -6813,13 +7007,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that contains the dashboard that you're embedding.
", + "documentation":"The ID for the Amazon Web Services account; that contains the dashboard that you're embedding.
", "location":"uri", "locationName":"AwsAccountId" }, "DashboardId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.
", + "documentation":"The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
", "location":"uri", "locationName":"DashboardId" }, @@ -6861,7 +7055,7 @@ }, "Namespace":{ "shape":"Namespace", - "documentation":"The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to \"default\".
The Amazon QuickSight namespace that the user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } }, "documentation":"Output returned from the GetDashboardEmbedUrl operation.
The ID for the AWS account associated with your QuickSight subscription.
", + "documentation":"The ID for the Amazon Web Services account; associated with your QuickSight subscription.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -6916,7 +7110,7 @@ }, "UserArn":{ "shape":"Arn", - "documentation":"The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
", + "documentation":"The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
", "location":"querystring", "locationName":"user-arn" } @@ -6936,7 +7130,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -7025,7 +7219,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
" + "documentation":"The Amazon Web Services account; ID.
" }, "AssignmentId":{ "shape":"String", @@ -7048,7 +7242,7 @@ "documentation":"Assignment status.
" } }, - "documentation":"An AWS Identity and Access Management (IAM) policy assignment.
" + "documentation":"An Identity and Access Management (IAM) policy assignment.
" }, "IAMPolicyAssignmentName":{ "type":"string", @@ -7104,7 +7298,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The identity type specified isn't supported. Supported identity types include IAM and QUICKSIGHT.
The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"An internal failure occurred.
", @@ -7333,7 +7527,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The NextToken value isn't valid.
The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"One or more parameters has a value that isn't valid.
", @@ -7430,7 +7624,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"A limit is exceeded.
", @@ -7443,7 +7637,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analyses.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analyses.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7480,7 +7674,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -7493,7 +7687,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're listing versions for.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're listing versions for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7536,7 +7730,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -7546,7 +7740,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboards that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboards that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7570,7 +7764,7 @@ "members":{ "DashboardSummaryList":{ "shape":"DashboardSummaryList", - "documentation":"A structure that contains all of the dashboards in your AWS account. This structure provides basic information about the dashboards.
" + "documentation":"A structure that contains all of the dashboards in your Amazon Web Services account;. This structure provides basic information about the dashboards.
" }, "NextToken":{ "shape":"String", @@ -7583,7 +7777,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -7593,7 +7787,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7625,7 +7819,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -7640,7 +7834,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7672,7 +7866,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -7813,7 +8007,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7838,7 +8032,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -7856,7 +8050,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7894,7 +8088,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -7913,7 +8107,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the assignments.
", + "documentation":"The ID of the Amazon Web Services account; that contains the assignments.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -7953,7 +8147,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "NextToken":{ "shape":"String", @@ -7975,7 +8169,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains these IAM policy assignments.
", + "documentation":"The ID of the Amazon Web Services account; that contains these IAM policy assignments.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8017,7 +8211,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8047,7 +8241,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8073,7 +8267,7 @@ }, "RequestId":{ "shape":"string", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8088,7 +8282,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that contains the QuickSight namespaces that you want to list.
", + "documentation":"The ID for the Amazon Web Services account; that contains the QuickSight namespaces that you want to list.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8112,7 +8306,7 @@ "members":{ "Namespaces":{ "shape":"Namespaces", - "documentation":"The information about the namespaces in this AWS account. The response includes the namespace ARN, name, AWS Region, notification email address, creation status, and identity store.
" + "documentation":"The information about the namespaces in this Amazon Web Services account;. The response includes the namespace ARN, name, Region;, notification email address, creation status, and identity store.
" }, "NextToken":{ "shape":"String", @@ -8120,7 +8314,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8150,7 +8344,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8168,7 +8362,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template aliases that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template aliases that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8207,7 +8401,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "NextToken":{ "shape":"String", @@ -8224,7 +8418,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the templates that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the templates that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8267,7 +8461,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -8277,7 +8471,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the templates that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the templates that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8314,7 +8508,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -8327,7 +8521,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme aliases that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme aliases that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8366,7 +8560,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "NextToken":{ "shape":"String", @@ -8383,7 +8577,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the themes that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the themes that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8426,7 +8620,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -8436,7 +8630,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the themes that you're listing.
", + "documentation":"The ID of the Amazon Web Services account; that contains the themes that you're listing.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8455,7 +8649,7 @@ }, "Type":{ "shape":"ThemeType", - "documentation":"The type of themes that you want to list. Valid options include the following:
ALL (default)- Display all existing themes.
CUSTOM - Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT - Display only the starting themes defined by QuickSight.
The type of themes that you want to list. Valid options include the following:
ALL (default)- Display all existing themes.
CUSTOM - Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -8499,7 +8693,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The Amazon Web Services account; ID that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8537,7 +8731,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8555,7 +8749,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -8593,7 +8787,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -8802,7 +8996,7 @@ }, "CapacityRegion":{ "shape":"String", - "documentation":"The namespace AWS Region.
" + "documentation":"The namespace Region;.
" }, "CreationStatus":{ "shape":"NamespaceStatus", @@ -8994,7 +9188,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"One or more preconditions aren't met.
", @@ -9081,7 +9275,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9182,7 +9376,7 @@ }, "CustomPermissionsName":{ "shape":"RoleName", - "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
" + "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions.
" }, "ExternalLoginFederationProviderType":{ "shape":"String", @@ -9211,7 +9405,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -9220,6 +9414,41 @@ } } }, + "RegisteredUserDashboardEmbeddingConfiguration":{ + "type":"structure", + "required":["InitialDashboardId"], + "members":{ + "InitialDashboardId":{ + "shape":"RestrictiveResourceId", + "documentation":"The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
" + } + }, + "documentation":"Information about the dashboard you want to embed.
" + }, + "RegisteredUserEmbeddingExperienceConfiguration":{ + "type":"structure", + "members":{ + "Dashboard":{ + "shape":"RegisteredUserDashboardEmbeddingConfiguration", + "documentation":"The configuration details for providing a dashboard embedding experience.
" + }, + "QuickSightConsole":{ + "shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration", + "documentation":"The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" + } + }, + "documentation":"The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.
Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuraton.
The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
Information about the Amazon QuickSight console that you want to embed.
" + }, "RelationalTable":{ "type":"structure", "required":[ @@ -9292,7 +9521,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The resource specified already exists.
", @@ -9315,7 +9544,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"One or more resources can't be found.
", @@ -9331,7 +9560,7 @@ "members":{ "Principal":{ "shape":"Principal", - "documentation":"The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account; root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"This resource is currently unavailable.
", @@ -9384,7 +9613,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analysis.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analysis.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9414,7 +9643,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -9474,6 +9703,10 @@ "FormatVersion":{ "shape":"RowLevelPermissionFormatVersion", "documentation":"The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.
The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
" + } + }, + "documentation":"The configuration of tags on a dataset to set row-level security.
" + }, + "RowLevelPermissionTagDelimiter":{ + "type":"string", + "max":10 + }, + "RowLevelPermissionTagRule":{ + "type":"structure", + "required":[ + "TagKey", + "ColumnName" + ], + "members":{ + "TagKey":{ + "shape":"SessionTagKey", + "documentation":"The unique key for a tag.
" + }, + "ColumnName":{ + "shape":"String", + "documentation":"The column name that a tag key is assigned to.
" + }, + "TagMultiValueDelimiter":{ + "shape":"RowLevelPermissionTagDelimiter", + "documentation":"A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
" + }, + "MatchAllValue":{ + "shape":"SessionTagValue", + "documentation":"A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
" + } + }, + "documentation":"A set of rules associated with a tag.
" + }, + "RowLevelPermissionTagRuleList":{ + "type":"list", + "member":{"shape":"RowLevelPermissionTagRule"}, + "max":50, + "min":1 + }, "S3Bucket":{ "type":"string", "max":1024, @@ -9508,7 +9792,7 @@ "members":{ "ManifestFileLocation":{ "shape":"ManifestFileLocation", - "documentation":"Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
" + "documentation":"Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into QuickSight.
" } }, "documentation":"S3 parameters.
" @@ -9544,7 +9828,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analyses that you're searching for.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analyses that you're searching for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9581,7 +9865,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -9594,7 +9878,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the user whose dashboards you're searching for.
", + "documentation":"The ID of the Amazon Web Services account; that contains the user whose dashboards you're searching for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -9631,7 +9915,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -9707,13 +9991,48 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
", "error":{"httpStatusCode":400}, "exception":true }, + "SessionTag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"SessionTagKey", + "documentation":"The key for the tag.
" + }, + "Value":{ + "shape":"SessionTagValue", + "documentation":"The value that you want to assign the tag.
" + } + }, + "documentation":"The key-value pair used for the row-level security tags feature.
" + }, + "SessionTagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "SessionTagList":{ + "type":"list", + "member":{"shape":"SessionTag"}, + "max":50, + "min":1 + }, + "SessionTagValue":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, "Sheet":{ "type":"structure", "members":{ @@ -9726,7 +10045,7 @@ "documentation":"The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.
" } }, - "documentation":"A sheet, which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
" + "documentation":"A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
" }, "SheetControlsOption":{ "type":"structure", @@ -9841,6 +10160,13 @@ }, "documentation":"Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
" }, + "Status":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "StatusCode":{"type":"integer"}, "String":{"type":"string"}, "StringList":{ @@ -9901,7 +10227,7 @@ }, "Tags":{ "shape":"ColumnTagList", - "documentation":"The dataset column tag, currently only used for geospatial type tagging. .
This is not tags for the AWS tagging feature. .
The dataset column tag, currently only used for geospatial type tagging.
This is not tags for the Amazon Web Services tagging feature.
A transform operation that tags a column with additional information.
" @@ -9947,7 +10273,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -9978,7 +10304,7 @@ }, "TemplateId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID for the template. This is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the template. This is unique per Region; for each Amazon Web Services account;.
" }, "LastUpdatedTime":{ "shape":"Timestamp", @@ -9989,7 +10315,7 @@ "documentation":"Time when this was created.
" } }, - "documentation":"A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.
" + "documentation":"A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.
" }, "TemplateAlias":{ "type":"structure", @@ -10099,7 +10425,7 @@ }, "TemplateId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID of the template. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the template. This ID is unique per Region; for each Amazon Web Services account;.
" }, "Name":{ "shape":"TemplateName", @@ -10341,7 +10667,7 @@ }, "ThemeId":{ "shape":"RestrictiveResourceId", - "documentation":"The ID of the theme. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the theme. This ID is unique per Region; for each Amazon Web Services account;.
" }, "LatestVersionNumber":{ "shape":"VersionNumber", @@ -10446,7 +10772,7 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"Access is throttled.
", @@ -10616,10 +10942,10 @@ "Message":{"shape":"String"}, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, - "documentation":"This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your AWS account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the --identity-type ANONYMOUS option.
This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account;. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the --identity-type ANONYMOUS option.
The AWS request ID for this request.
" + "documentation":"The Amazon Web Services request ID for this request.
" } }, "documentation":"This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
", @@ -10662,7 +10988,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -10680,7 +11006,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to update QuickSight customizations for.
", + "documentation":"The ID for the Amazon Web Services account; that you want to update QuickSight customizations for.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -10692,7 +11018,7 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The QuickSight customizations you're updating in the current AWS Region.
" + "documentation":"The QuickSight customizations you're updating in the current Region;.
" } } }, @@ -10701,11 +11027,11 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the updated customization for this AWS account.
" + "documentation":"The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account;.
" }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that you want to update QuickSight customizations for.
" + "documentation":"The ID for the Amazon Web Services account; that you want to update QuickSight customizations for.
" }, "Namespace":{ "shape":"Namespace", @@ -10713,11 +11039,11 @@ }, "AccountCustomization":{ "shape":"AccountCustomization", - "documentation":"The QuickSight customizations you're updating in the current AWS Region.
" + "documentation":"The QuickSight customizations you're updating in the current Region;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -10735,17 +11061,17 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that contains the QuickSight settings that you want to list.
", + "documentation":"The ID for the Amazon Web Services account; that contains the QuickSight settings that you want to list.
", "location":"uri", "locationName":"AwsAccountId" }, "DefaultNamespace":{ "shape":"Namespace", - "documentation":"The default namespace for this AWS account. Currently, the default is default. AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.
The default namespace for this Amazon Web Services account;. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.
The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.
" + "documentation":"The email address that you want QuickSight to send notifications to regarding your Amazon Web Services account; or QuickSight subscription.
" } } }, @@ -10754,7 +11080,7 @@ "members":{ "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -10772,7 +11098,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account; that the analysis is in.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -10809,7 +11135,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -10829,7 +11155,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the analysis that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the analysis that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -10879,7 +11205,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -10892,7 +11218,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard whose permissions you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard whose permissions you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -10929,7 +11255,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -10948,7 +11274,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -10984,7 +11310,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -10999,7 +11325,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the dashboard that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the dashboard that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11015,7 +11341,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.
Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.
" + "documentation":"The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account; where you create the dashboard.
" } } }, @@ -11060,7 +11386,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -11073,13 +11399,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSetId" }, @@ -11102,11 +11428,11 @@ }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the dataset whose permissions you want to update. This ID is unique per Region; for each Amazon Web Services account;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11127,13 +11453,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSetId":{ "shape":"ResourceId", - "documentation":"The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID for the dataset that you want to update. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSetId" }, @@ -11165,6 +11491,10 @@ "shape":"RowLevelPermissionDataSet", "documentation":"The row-level security configuration for the data you want to create.
" }, + "RowLevelPermissionTagConfiguration":{ + "shape":"RowLevelPermissionTagConfiguration", + "documentation":"The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
" + }, "ColumnLevelPermissionRules":{ "shape":"ColumnLevelPermissionRuleList", "documentation":"A set of one or more definitions of a ColumnLevelPermissionRule .
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
" }, "IngestionArn":{ "shape":"Arn", @@ -11192,7 +11522,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11210,13 +11540,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSourceId" }, @@ -11239,11 +11569,11 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11262,13 +11592,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS account ID.
", + "documentation":"The Amazon Web Services account; ID.
", "location":"uri", "locationName":"AwsAccountId" }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
", "location":"uri", "locationName":"DataSourceId" }, @@ -11303,7 +11633,7 @@ }, "DataSourceId":{ "shape":"ResourceId", - "documentation":"The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "documentation":"The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
" }, "UpdateStatus":{ "shape":"ResourceStatus", @@ -11311,7 +11641,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11442,7 +11772,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the group is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11463,7 +11793,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11482,13 +11812,13 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the IAM policy assignment.
", + "documentation":"The ID of the Amazon Web Services account; that contains the IAM policy assignment.
", "location":"uri", "locationName":"AwsAccountId" }, "AssignmentName":{ "shape":"IAMPolicyAssignmentName", - "documentation":"The name of the assignment, also called a rule. This name must be unique within an AWS account.
", + "documentation":"The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account;.
", "location":"uri", "locationName":"AssignmentName" }, @@ -11537,7 +11867,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11562,7 +11892,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template alias that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template alias that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11598,7 +11928,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -11611,7 +11941,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11648,7 +11978,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11667,7 +11997,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the template that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the template that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11679,7 +12009,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.
Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -11732,7 +12062,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme alias that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme alias that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11768,7 +12098,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -11781,7 +12111,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11818,7 +12148,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -11837,7 +12167,7 @@ "members":{ "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID of the AWS account that contains the theme that you're updating.
", + "documentation":"The ID of the Amazon Web Services account; that contains the theme that you're updating.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11853,7 +12183,7 @@ }, "BaseThemeId":{ "shape":"RestrictiveResourceId", - "documentation":"The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
" + "documentation":"The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
" }, "VersionDescription":{ "shape":"VersionDescription", @@ -11891,7 +12221,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" } } }, @@ -11913,7 +12243,7 @@ }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "documentation":"The ID for the Amazon Web Services account; that the user is in. Currently, you use the ID for the Amazon Web Services account; that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -11933,7 +12263,7 @@ }, "CustomPermissionsName":{ "shape":"RoleName", - "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
" + "documentation":"(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions.
" }, "UnapplyCustomPermissions":{ "shape":"Boolean", @@ -11962,7 +12292,7 @@ }, "RequestId":{ "shape":"String", - "documentation":"The AWS request ID for this operation.
" + "documentation":"The Amazon Web Services request ID for this operation.
" }, "Status":{ "shape":"StatusCode", @@ -12107,5 +12437,5 @@ "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, - "documentation":"Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
" + "documentation":"Amazon QuickSight is a fully managed, serverless business intelligence service for the Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
" } From 30d3ba50ef8f6ead8d5f476256e76a273ccf90b6 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:56 +0000 Subject: [PATCH 04/14] Amazon Route 53 Update: This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller. --- .../feature-AmazonRoute53-fb8b7d7.json | 6 + .../codegen-resources/service-2.json | 194 ++++++++++-------- 2 files changed, 111 insertions(+), 89 deletions(-) create mode 100644 .changes/next-release/feature-AmazonRoute53-fb8b7d7.json diff --git a/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json b/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json new file mode 100644 index 000000000000..24c22722aa89 --- /dev/null +++ b/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Route 53", + "contributor": "", + "description": "This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller." +} diff --git a/services/route53/src/main/resources/codegen-resources/service-2.json b/services/route53/src/main/resources/codegen-resources/service-2.json index d62154bcb3a3..e740e45c3145 100644 --- a/services/route53/src/main/resources/codegen-resources/service-2.json +++ b/services/route53/src/main/resources/codegen-resources/service-2.json @@ -25,7 +25,8 @@ {"shape":"NoSuchKeySigningKey"}, {"shape":"InvalidKeySigningKeyStatus"}, {"shape":"InvalidSigningStatus"}, - {"shape":"InvalidKMSArn"} + {"shape":"InvalidKMSArn"}, + {"shape":"InvalidInput"} ], "documentation":"Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one account with a private hosted zone that was created by using a different account, the account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.
For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.
If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.
Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.
For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.
If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.
Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use ChangeResourceRecordsSetsRequest to perform the following actions:
CREATE: Creates a resource record set that has the specified values.
DELETE: Deletes an existing resource record set that has the specified values.
UPSERT: If a resource record set does not already exist, Amazon Web Services creates it. If a resource set does exist, Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see \"Examples.\"
Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.
Change Propagation to Route 53 DNS Servers
When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.
Limits on ChangeResourceRecordSets Requests
For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + "documentation":"Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
" }, "CreateHealthCheck":{ "name":"CreateHealthCheck", @@ -189,7 +190,7 @@ {"shape":"QueryLoggingConfigAlreadyExists"}, {"shape":"InsufficientCloudWatchLogsResourcePolicy"} ], - "documentation":"Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as NoError or ServFail
Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region.
You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.
When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
/aws/route53/hosted zone name
In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:
arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI.
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.
For information about charges for query logs, see Amazon CloudWatch Pricing.
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.
DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:
Route 53 edge location that responded to the DNS query
Domain or subdomain that was requested
DNS record type, such as A or AAAA
DNS response code, such as NoError or ServFail
Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.
Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region.
You must use the same account to create the log group and the hosted zone that you want to configure query logging for.
When you create log groups for query logging, we recommend that you use a consistent prefix, for example:
/aws/route53/hosted zone name
In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.
Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:
arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*
You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
When Route 53 finishes creating the configuration for DNS query logging, it does the following:
Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.
Begins to send query logs to the applicable log stream.
The name of each log stream is in the following format:
hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.
Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.
For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.
For information about charges for query logs, see Amazon CloudWatch Pricing.
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same AWS account.
You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same account.
You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.
The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:
Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
Recreate resource record sets in the new hosted zones.
Change the registrar's name servers to use the name servers for the new hosted zones.
Monitor traffic for the website or application.
Change TTLs back to their original values.
If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:
For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.
For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.
For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.
Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
Authorizes the account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE.
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
If you're using AWS Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.
Deletes a hosted zone.
If the hosted zone was created by another service, such as AWS Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)
If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.
If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.
If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on \"free DNS service.\"
You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.
To verify that the hosted zone has been deleted, do one of the following:
Use the GetHostedZone action to request information about the hosted zone.
Use the ListHostedZones action to get a list of the hosted zones associated with the current AWS account.
Deletes a hosted zone.
If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)
If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.
If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.
If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on \"free DNS service.\"
You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.
To verify that the hosted zone has been deleted, do one of the following:
Use the GetHostedZone action to request information about the hosted zone.
Use the ListHostedZones action to get a list of the hosted zones associated with the current account.
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.
" }, @@ -449,7 +452,7 @@ {"shape":"InvalidVPCId"}, {"shape":"InvalidInput"} ], - "documentation":"Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.
Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.
Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.
Sending this request only prevents the account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.
Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.
" }, @@ -489,7 +493,7 @@ {"shape":"LastVPCAssociation"}, {"shape":"InvalidInput"} ], - "documentation":"Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
You can't disassociate the last Amazon VPC from a private hosted zone.
You can't convert a private hosted zone into a public hosted zone.
You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the Amazon VPC.
Some services, such as AWS Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.
When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:
You can't disassociate the last Amazon VPC from a private hosted zone.
You can't convert a private hosted zone into a public hosted zone.
You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the Amazon VPC.
Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.
When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.
Enables DNSSEC signing in a specific hosted zone.
" }, @@ -522,7 +527,7 @@ "errors":[ {"shape":"InvalidInput"} ], - "documentation":"Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
You can also view account limits in AWS Trusted Advisor. Sign in to the AWS Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
" }, @@ -599,7 +605,7 @@ }, "input":{"shape":"GetHealthCheckCountRequest"}, "output":{"shape":"GetHealthCheckCountResponse"}, - "documentation":"Retrieves the number of health checks that are associated with the current AWS account.
" + "documentation":"Retrieves the number of health checks that are associated with the current account.
" }, "GetHealthCheckLastFailureReason":{ "name":"GetHealthCheckLastFailureReason", @@ -627,7 +633,7 @@ {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidInput"} ], - "documentation":"Gets status of a specified health check.
" + "documentation":"Gets status of a specified health check.
This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.
Retrieves the number of hosted zones that are associated with the current AWS account.
" + "documentation":"Retrieves the number of hosted zones that are associated with the current account.
" }, "GetHostedZoneLimit":{ "name":"GetHostedZoneLimit", @@ -750,7 +756,7 @@ }, "input":{"shape":"GetTrafficPolicyInstanceCountRequest"}, "output":{"shape":"GetTrafficPolicyInstanceCountResponse"}, - "documentation":"Gets the number of traffic policy instances that are associated with the current AWS account.
" + "documentation":"Gets the number of traffic policy instances that are associated with the current account.
" }, "ListGeoLocations":{ "name":"ListGeoLocations", @@ -777,7 +783,7 @@ {"shape":"InvalidInput"}, {"shape":"IncompatibleVersion"} ], - "documentation":"Retrieve a list of the health checks that are associated with the current AWS account.
" + "documentation":"Retrieve a list of the health checks that are associated with the current account.
" }, "ListHostedZones":{ "name":"ListHostedZones", @@ -792,7 +798,7 @@ {"shape":"NoSuchDelegationSet"}, {"shape":"DelegationSetNotReusable"} ], - "documentation":"Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.
Retrieves a list of the public and private hosted zones that are associated with the current account. The response includes a HostedZones child element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.
Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.
ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current account.
ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:
com.ex\\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.
The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated with the current account.
If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.
The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
Lists all the private hosted zones that a specified VPC is associated with, regardless of which AWS account or AWS service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:
An OwningAccount element, which contains the account number of either the current AWS account or another AWS account. Some services, such as AWS Cloud Map, create hosted zones using the current account.
An OwningService element, which identifies the AWS service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is efs.amazonaws.com.
Lists all the private hosted zones that a specified VPC is associated with, regardless of which account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:
An OwningAccount element, which contains the account number of either the current account or another account. Some services, such as Cloud Map, create hosted zones using the current account.
An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is efs.amazonaws.com.
Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
" + "documentation":"Lists the configurations for DNS query logging that are associated with the current account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
" }, "ListResourceRecordSets":{ "name":"ListResourceRecordSets", @@ -862,7 +868,7 @@ "errors":[ {"shape":"InvalidInput"} ], - "documentation":"Retrieves a list of the reusable delegation sets that are associated with the current AWS account.
" + "documentation":"Retrieves a list of the reusable delegation sets that are associated with the current account.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -879,7 +885,7 @@ {"shape":"PriorRequestNotComplete"}, {"shape":"ThrottlingException"} ], - "documentation":"Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + "documentation":"Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
" }, "ListTagsForResources":{ "name":"ListTagsForResources", @@ -900,7 +906,7 @@ {"shape":"PriorRequestNotComplete"}, {"shape":"ThrottlingException"} ], - "documentation":"Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" + "documentation":"Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
" }, "ListTrafficPolicies":{ "name":"ListTrafficPolicies", @@ -913,7 +919,7 @@ "errors":[ {"shape":"InvalidInput"} ], - "documentation":"Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.
Gets information about the latest version for every traffic policy that is associated with the current account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.
Gets information about the traffic policy instances that you created by using the current AWS account.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
Gets information about the traffic policy instances that you created by using the current account.
After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.
AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
Alias resource records sets only: The value used depends on where you want to route traffic:
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalHostedZoneId.
For edge-optimized APIs, specify the value of distributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.
CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:
For regional APIs, specify the value of regionalDomainName.
For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.
For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:
AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.
AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS CLI Command Reference.
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.
AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
AWS CLI: To get the DNS name, use describe-accelerator.
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Specify the value of the Name element for a resource record set in the current hosted zone.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Alias resource record sets only: The value that you specify depends on where you want to route queries:
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
For regional APIs, specify the value of regionalDomainName.
For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.
For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:
Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.
Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.
CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the CLI Command Reference.
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Management Console, the ELB API, or the CLI.
Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: DescribeLoadBalancers
Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
Classic Load Balancers: describe-load-balancers
Application and Network Load Balancers: describe-load-balancers
Specify the DNS name for your accelerator:
Global Accelerator API: To get the DNS name, use DescribeAccelerator.
CLI: To get the DNS name, use describe-accelerator.
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Specify the value of the Name element for a resource record set in the current hosted zone.
If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
Health checking behavior depends on the type of load balancer:
Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
" + "documentation":" Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.
Note the following:
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.
If the environment contains a single Amazon EC2 instance, there are no special requirements.
Health checking behavior depends on the type of load balancer:
Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:
For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
If the Amazon Web Services resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
" } }, - "documentation":"Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
The ID of the request.
" + "documentation":"This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
" }, "Status":{ "shape":"ChangeStatus", @@ -1284,7 +1290,7 @@ }, "Comment":{ "shape":"ResourceDescription", - "documentation":"A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
" + "documentation":"A comment you can provide.
" } }, "documentation":"A complex type that describes change information about changes made to your hosted zone.
" @@ -1628,7 +1634,7 @@ }, "KeyManagementServiceArn":{ "shape":"SigningKeyString", - "documentation":"The Amazon resource name (ARN) for a customer managed customer master key (CMK) in AWS Key Management Service (AWS KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.
You must configure the customer managed CMK as follows:
Enabled
ECC_NIST_P256
Sign and verify
The key policy must give permission for the following actions:
DescribeKey
GetPublicKey
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
\"Service\": \"dnssec.route53.aws.amazonaws.com\"
For more information about working with a customer managed CMK in AWS KMS, see AWS Key Management Service concepts.
" + "documentation":"The Amazon resource name (ARN) for a customer managed customer master key (CMK) in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.
You must configure the customer managed CMK as follows:
Enabled
ECC_NIST_P256
Sign and verify
The key policy must give permission for the following actions:
DescribeKey
GetPublicKey
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
\"Service\": \"dnssec-route53.amazonaws.com\"
For more information about working with a customer managed CMK in KMS, see Key Management Service concepts.
" }, "Name":{ "shape":"SigningKeyName", @@ -1674,7 +1680,7 @@ }, "CloudWatchLogsLogGroupArn":{ "shape":"CloudWatchLogsLogGroupArn", - "documentation":"The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:
arn:aws:logs:region:account-id:log-group:log_group_name
To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the AWS SDKs.
" + "documentation":"The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:
arn:aws:logs:region:account-id:log-group:log_group_name
To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.
" } } }, @@ -2215,16 +2221,16 @@ "members":{ "HostedZoneId":{ "shape":"ResourceId", - "documentation":"When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.
", + "documentation":"When removing authorization to associate a VPC that was created by one account with a hosted zone that was created with a different account, the ID of the hosted zone.
", "location":"uri", "locationName":"Id" }, "VPC":{ "shape":"VPC", - "documentation":"When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.
" + "documentation":"When removing authorization to associate a VPC that was created by one account with a hosted zone that was created with a different account, a complex type that includes the ID and region of the VPC.
" } }, - "documentation":"A complex type that contains information about the request to remove authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account.
" + "documentation":"A complex type that contains information about the request to remove authorization to associate a VPC that was created by one account with a hosted zone that was created with a different account.
" }, "DeleteVPCAssociationAuthorizationResponse":{ "type":"structure", @@ -2585,7 +2591,7 @@ "type":"structure", "members":{ }, - "documentation":"A request for the number of health checks that are associated with the current AWS account.
" + "documentation":"A request for the number of health checks that are associated with the current account.
" }, "GetHealthCheckCountResponse":{ "type":"structure", @@ -2593,7 +2599,7 @@ "members":{ "HealthCheckCount":{ "shape":"HealthCheckCount", - "documentation":"The number of health checks associated with the current AWS account.
" + "documentation":"The number of health checks associated with the current account.
" } }, "documentation":"A complex type that contains the response to a GetHealthCheckCount request.
A complex type that contains information about one health check that is associated with the current AWS account.
" + "documentation":"A complex type that contains information about one health check that is associated with the current account.
" } }, "documentation":"A complex type that contains the response to a GetHealthCheck request.
A request to retrieve a count of all the hosted zones that are associated with the current AWS account.
" + "documentation":"A request to retrieve a count of all the hosted zones that are associated with the current account.
" }, "GetHostedZoneCountResponse":{ "type":"structure", @@ -2682,7 +2688,7 @@ "members":{ "HostedZoneCount":{ "shape":"HostedZoneCount", - "documentation":"The total number of public and private hosted zones that are associated with the current AWS account.
" + "documentation":"The total number of public and private hosted zones that are associated with the current account.
" } }, "documentation":"A complex type that contains the response to a GetHostedZoneCount request.
Request to get the number of traffic policy instances that are associated with the current AWS account.
" + "documentation":"Request to get the number of traffic policy instances that are associated with the current account.
" }, "GetTrafficPolicyInstanceCountResponse":{ "type":"structure", @@ -2857,7 +2863,7 @@ "members":{ "TrafficPolicyInstanceCount":{ "shape":"TrafficPolicyInstanceCount", - "documentation":"The number of traffic policy instances that are associated with the current AWS account.
" + "documentation":"The number of traffic policy instances that are associated with the current account.
" } }, "documentation":"A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
" @@ -2953,7 +2959,7 @@ "documentation":"A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
" } }, - "documentation":"A complex type that contains information about one health check that is associated with the current AWS account.
" + "documentation":"A complex type that contains information about one health check that is associated with the current Amazon Web Services account.
" }, "HealthCheckAlreadyExists":{ "type":"structure", @@ -2981,7 +2987,7 @@ }, "Type":{ "shape":"HealthCheckType", - "documentation":"The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.
HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
TCP: Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
" + "documentation":"The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.
HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
TCP: Route 53 tries to establish a TCP connection.
CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.
CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.
RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
" }, "ResourcePath":{ "shape":"ResourcePath", @@ -3005,7 +3011,7 @@ }, "MeasureLatency":{ "shape":"MeasureLatency", - "documentation":"Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.
You can't change the value of MeasureLatency after you create a health check.
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy: Route 53 considers the health check to be healthy.
Unhealthy: Route 53 considers the health check to be unhealthy.
LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
The Amazon Resource Name (ARN) for Route53 Application Recovery Controller routing control.
" } }, "documentation":"A complex type that contains information about the health check.
" @@ -3123,7 +3133,8 @@ "HTTPS_STR_MATCH", "TCP", "CALCULATED", - "CLOUDWATCH_METRIC" + "CLOUDWATCH_METRIC", + "RECOVERY_CONTROL" ] }, "HealthCheckVersion":{ @@ -3277,11 +3288,11 @@ "members":{ "OwningAccount":{ "shape":"AWSAccountID", - "documentation":"If the hosted zone was created by an AWS account, or was created by an AWS service that creates hosted zones using the current account, OwningAccount contains the account ID of that account. For example, when you use AWS Cloud Map to create a hosted zone, Cloud Map creates the hosted zone using the current AWS account.
If the hosted zone was created by an account, or was created by an Amazon Web Services service that creates hosted zones using the current account, OwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map creates the hosted zone using the current account.
If an AWS service uses its own account to create a hosted zone and associate the specified VPC with that hosted zone, OwningService contains an abbreviation that identifies the service. For example, if Amazon Elastic File System (Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value of OwningService is efs.amazonaws.com.
If an Amazon Web Services service uses its own account to create a hosted zone and associate the specified VPC with that hosted zone, OwningService contains an abbreviation that identifies the service. For example, if Amazon Elastic File System (Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value of OwningService is efs.amazonaws.com.
A complex type that identifies a hosted zone that a specified Amazon VPC is associated with and the owner of the hosted zone. If there is a value for OwningAccount, there is no value for OwningService, and vice versa.
The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an AWS account or an AWS service.
" + "documentation":"The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an account or an Amazon Web Services service.
" } }, "documentation":"In the response to a ListHostedZonesByVPC request, the HostedZoneSummaries element contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.
Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:
There is no resource policy that specifies the log group ARN in the value for Resource.
The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:
There is no resource policy that specifies the log group ARN in the value for Resource.
The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.
The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in AWS Key Management Service (AWS KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the CMK as follows:
Enabled
ECC_NIST_P256
Sign and verify
The key policy must give permission for the following actions:
DescribeKey
GetPublicKey
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
\"Service\": \"api-service.dnssec.route53.aws.internal\"
For more information about working with the customer managed CMK in AWS KMS, see AWS Key Management Service concepts.
" + "documentation":"The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the CMK as follows:
Enabled
ECC_NIST_P256
Sign and verify
The key policy must give permission for the following actions:
DescribeKey
GetPublicKey
Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
\"Service\": \"dnssec-route53.amazonaws.com\"
For more information about working with the customer managed CMK in KMS, see Key Management Service concepts.
" }, "Flag":{ "shape":"SigningKeyInteger", @@ -3616,7 +3627,7 @@ "documentation":"" } }, - "documentation":"This operation can't be completed either because the current account has reached the limit on reusable delegation sets that it can create or because you've reached the limit on the number of Amazon VPCs that you can associate with a private hosted zone. To get the current limit on the number of reusable delegation sets, see GetAccountLimit. To get the current limit on the number of Amazon VPCs that you can associate with a private hosted zone, see GetHostedZoneLimit. To request a higher limit, create a case with the AWS Support Center.
", + "documentation":"This operation can't be completed either because the current account has reached the limit on reusable delegation sets that it can create or because you've reached the limit on the number of Amazon VPCs that you can associate with a private hosted zone. To get the current limit on the number of reusable delegation sets, see GetAccountLimit. To get the current limit on the number of Amazon VPCs that you can associate with a private hosted zone, see GetHostedZoneLimit. To request a higher limit, create a case with the Amazon Web Services Support Center.
", "exception":true }, "LinkedService":{ @@ -3714,7 +3725,7 @@ "locationName":"maxitems" } }, - "documentation":"A request to retrieve a list of the health checks that are associated with the current AWS account.
" + "documentation":"A request to retrieve a list of the health checks that are associated with the current account.
" }, "ListHealthChecksResponse":{ "type":"structure", @@ -3727,7 +3738,7 @@ "members":{ "HealthChecks":{ "shape":"HealthChecks", - "documentation":"A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.
A complex type that contains one HealthCheck element for each health check that is associated with the current account.
(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.
(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.
Retrieves a list of the public and private hosted zones that are associated with the current AWS account in ASCII order by domain name.
" + "documentation":"Retrieves a list of the public and private hosted zones that are associated with the current account in ASCII order by domain name.
" }, "ListHostedZonesByNameResponse":{ "type":"structure", @@ -3826,7 +3837,7 @@ }, "VPCRegion":{ "shape":"VPCRegion", - "documentation":"For the Amazon VPC that you specified for VPCId, the AWS Region that you created the VPC in.
For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.
Lists all the private hosted zones that a specified VPC is associated with, regardless of which AWS account created the hosted zones.
" + "documentation":"Lists all the private hosted zones that a specified VPC is associated with, regardless of which account created the hosted zones.
" }, "ListHostedZonesByVPCResponse":{ "type":"structure", @@ -3862,7 +3873,7 @@ }, "NextToken":{ "shape":"PaginationToken", - "documentation":"The value that you specified for NextToken in the most recent ListHostedZonesByVPC request.
The value that you will use for NextToken in the next ListHostedZonesByVPC request.
A request to retrieve a list of the public and private hosted zones that are associated with the current AWS account.
" + "documentation":"A request to retrieve a list of the public and private hosted zones that are associated with the current account.
" }, "ListHostedZonesResponse":{ "type":"structure", @@ -3926,19 +3937,19 @@ "members":{ "HostedZoneId":{ "shape":"ResourceId", - "documentation":"(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current AWS account.
(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current account.
(Optional) If the current AWS account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
(Optional) If the current account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.
(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.
An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account.
" + "documentation":"An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current account.
" }, "NextToken":{ "shape":"PaginationToken", - "documentation":"If a response includes the last of the query logging configurations that are associated with the current AWS account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
If a response includes the last of the query logging configurations that are associated with the current account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
A request to get a list of the reusable delegation sets that are associated with the current AWS account.
" + "documentation":"A request to get a list of the reusable delegation sets that are associated with the current account.
" }, "ListReusableDelegationSetsResponse":{ "type":"structure", @@ -4059,7 +4070,7 @@ "members":{ "DelegationSets":{ "shape":"DelegationSets", - "documentation":"A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account.
A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current account.
The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.
A complex type that contains information about the reusable delegation sets that are associated with the current AWS account.
" + "documentation":"A complex type that contains information about the reusable delegation sets that are associated with the current account.
" }, "ListTagsForResourceRequest":{ "type":"structure", @@ -4160,7 +4171,7 @@ "locationName":"maxitems" } }, - "documentation":"A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
" + "documentation":"A complex type that contains the information about the request to list the traffic policies that are associated with the current account.
" }, "ListTrafficPoliciesResponse":{ "type":"structure", @@ -4173,7 +4184,7 @@ "members":{ "TrafficPolicySummaries":{ "shape":"TrafficPolicySummaries", - "documentation":"A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current account.
A request to get information about the traffic policy instances that you created by using the current AWS account.
" + "documentation":"A request to get information about the traffic policy instances that you created by using the current account.
" }, "ListTrafficPolicyInstancesResponse":{ "type":"structure", @@ -4758,7 +4769,7 @@ }, "RecordDataEntry":{ "type":"string", - "documentation":"A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:
For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.
For alias resource record sets that refer to AWS resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the AWS resource, depending on the type of resource.
For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:
For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.
For alias resource record sets that refer to Amazon Web Services resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the Amazon Web Services resource, depending on the type of resource.
For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
You can only specify one ResourceRecord per latency resource record set.
You can only create one latency resource record set for each Amazon EC2 Region.
You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1).
If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region (us-east-1).
This health check can't be created because the current account has reached the limit on the number of active health checks.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the AWS Support Center.
You have reached the maximum number of active health checks for an AWS account. To request a higher limit, create a case with the AWS Support Center.
", + "documentation":"This health check can't be created because the current account has reached the limit on the number of active health checks.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support Center.
You have reached the maximum number of active health checks for an account. To request a higher limit, create a case with the Amazon Web Services Support Center.
", "exception":true }, "TooManyHostedZones":{ @@ -5227,7 +5243,7 @@ "documentation":"" } }, - "documentation":"This operation can't be completed either because the current account has reached the limit on the number of hosted zones or because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
To get the current limit on hosted zones that can be associated with a reusable delegation set, see GetReusableDelegationSetLimit.
To request a higher limit, create a case with the AWS Support Center.
", + "documentation":"This operation can't be completed either because the current account has reached the limit on the number of hosted zones or because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
To get the current limit on hosted zones that can be associated with a reusable delegation set, see GetReusableDelegationSetLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -5247,7 +5263,7 @@ "documentation":"" } }, - "documentation":"This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the AWS Support Center.
", + "documentation":"This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -5259,7 +5275,7 @@ "documentation":"" } }, - "documentation":"This traffic policy instance can't be created because the current account has reached the limit on the number of traffic policy instances.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the AWS Support Center.
", + "documentation":"This traffic policy instance can't be created because the current account has reached the limit on the number of traffic policy instances.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -5486,10 +5502,10 @@ }, "TrafficPolicyCount":{ "shape":"TrafficPolicyVersion", - "documentation":"The number of traffic policies that are associated with the current AWS account.
" + "documentation":"The number of traffic policies that are associated with the current account.
" } }, - "documentation":"A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.
" + "documentation":"A complex type that contains information about the latest version of one traffic policy that is associated with the current account.
" }, "TrafficPolicyVersion":{ "type":"integer", From 06c59f75b09635656af0167408d0ef1d50fd9109 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:59 +0000 Subject: [PATCH 05/14] AWS Route53 Recovery Readiness Update: Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed. --- ...e-AWSRoute53RecoveryReadiness-3dba109.json | 6 + services/route53recoveryreadiness/pom.xml | 60 + .../codegen-resources/paginators-1.json | 76 + .../codegen-resources/service-2.json | 2770 +++++++++++++++++ 4 files changed, 2912 insertions(+) create mode 100644 .changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json create mode 100644 services/route53recoveryreadiness/pom.xml create mode 100644 services/route53recoveryreadiness/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/route53recoveryreadiness/src/main/resources/codegen-resources/service-2.json diff --git a/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json b/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json new file mode 100644 index 000000000000..276212334aa8 --- /dev/null +++ b/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Route53 Recovery Readiness", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed." +} diff --git a/services/route53recoveryreadiness/pom.xml b/services/route53recoveryreadiness/pom.xml new file mode 100644 index 000000000000..451fa7d56e7a --- /dev/null +++ b/services/route53recoveryreadiness/pom.xml @@ -0,0 +1,60 @@ + + + +Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the earlier compute environment from your job queue.
Delete the earlier compute environment.
Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete these steps:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the earlier compute environment from your job queue.
Delete the earlier compute environment.
Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
" + "documentation":"Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
" }, "DeleteComputeEnvironment":{ "name":"DeleteComputeEnvironment", @@ -66,7 +66,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Deletes an AWS Batch compute environment.
Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.
Deletes an Batch compute environment.
Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.
Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
" + "documentation":"Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
" }, "DescribeComputeEnvironments":{ "name":"DescribeComputeEnvironments", @@ -150,7 +150,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Describes a list of AWS Batch jobs.
" + "documentation":"Describes a list of Batch jobs.
" }, "ListJobs":{ "name":"ListJobs", @@ -164,7 +164,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Returns a list of AWS Batch jobs.
You must specify only one of the following items:
A job queue ID to return a list of jobs in that job queue
A multi-node parallel job ID to return a list of nodes for that job
An array job ID to return a list of the children for that job
You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.
Returns a list of Batch jobs.
You must specify only one of the following items:
A job queue ID to return a list of jobs in that job queue
A multi-node parallel job ID to return a list of nodes for that job
An array job ID to return a list of the children for that job
You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.
Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
" + "documentation":"Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
" }, "RegisterJobDefinition":{ "name":"RegisterJobDefinition", @@ -192,7 +192,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Registers an AWS Batch job definition.
" + "documentation":"Registers an Batch job definition.
" }, "SubmitJob":{ "name":"SubmitJob", @@ -206,7 +206,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Submits an AWS Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the ResourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a ResourceRequirements object that's included in the containerOverrides parameter.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the ResourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a ResourceRequirements object that's included in the containerOverrides parameter.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
Deletes specified tags from an AWS Batch resource.
" + "documentation":"Deletes specified tags from an Batch resource.
" }, "UpdateComputeEnvironment":{ "name":"UpdateComputeEnvironment", @@ -262,7 +262,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"Updates an AWS Batch compute environment.
" + "documentation":"Updates an Batch compute environment.
" }, "UpdateJobQueue":{ "name":"UpdateJobQueue", @@ -300,7 +300,7 @@ "documentation":"The size of the array job.
" } }, - "documentation":"An object representing an AWS Batch array job.
" + "documentation":"An object representing an Batch array job.
" }, "ArrayPropertiesDetail":{ "type":"structure", @@ -362,7 +362,7 @@ }, "logStreamName":{ "shape":"String", - "documentation":"The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
The AWS Batch job ID of the job to cancel.
" + "documentation":"The Batch job ID of the job to cancel.
" }, "reason":{ "shape":"String", - "documentation":"A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
" + "documentation":"A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.
" } }, "documentation":"Contains the parameters for CancelJob.
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
" + "documentation":"The compute resources defined for the compute environment. For more information, see Compute Environments in the Batch User Guide.
" }, "serviceRole":{ "shape":"String", - "documentation":"The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
" + "documentation":"The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
" } }, - "documentation":"An object representing an AWS Batch compute environment.
" + "documentation":"An object representing an Batch compute environment.
" }, "ComputeEnvironmentDetailList":{ "type":"list", @@ -543,7 +543,7 @@ "documentation":"The Amazon Resource Name (ARN) of the compute environment.
" } }, - "documentation":"The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the AWS Batch User Guide.
The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the Batch User Guide.
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is hitting Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.
AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.
Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.
Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values, based on job queue demand.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.
The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
" + "documentation":"The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
" }, "securityGroupIds":{ "shape":"StringList", - "documentation":"The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds is used.
The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags aren't seen when using the AWS Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created.Aany changes to these tags require that you create a new compute environment and remove the old compute environment. These tags aren't seen when using the Batch ListTagsForResource API operation.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the Batch User Guide.
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
An object representing an AWS Batch compute resource. For more information, see Compute Environments in the AWS Batch User Guide.
" + "documentation":"An object representing an Batch compute resource. For more information, see Compute Environments in the Batch User Guide.
" }, "ComputeResourceUpdate":{ "type":"structure", "members":{ "minvCpus":{ "shape":"Integer", - "documentation":"The minimum number of Amazon EC2 vCPUs that an environment should maintain.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The minimum number of Amazon EC2 vCPUs that an environment should maintain.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.
The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The VPC subnets that the compute resources are launched into. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
" + "documentation":"The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
" }, "securityGroupIds":{ "shape":"StringList", "documentation":"The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.
" } }, - "documentation":"An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the AWS Batch User Guide.
" + "documentation":"An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the Batch User Guide.
" }, "ContainerDetail":{ "type":"structure", @@ -681,7 +681,7 @@ }, "executionRoleArn":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
" + "documentation":"The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.
" }, "volumes":{ "shape":"Volumes", @@ -689,7 +689,7 @@ }, "environment":{ "shape":"EnvironmentVariables", - "documentation":"The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
The environment variables to pass to a container.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs running on Fargate resources.
A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources.
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs running on Fargate resources.
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
" + "documentation":"The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
" }, "networkConfiguration":{ "shape":"NetworkConfiguration", - "documentation":"The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
" + "documentation":"The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
" }, "fargatePlatformConfiguration":{ "shape":"FargatePlatformConfiguration", - "documentation":"The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
" + "documentation":"The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
" } }, "documentation":"An object representing the details of a container that's part of a job.
" @@ -771,13 +771,13 @@ "members":{ "vcpus":{ "shape":"Integer", - "documentation":"This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.
This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.
This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be be specified in several places. You must specify it at least once for each node.
This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead. You can use this parameter or resourceRequirements structure but not both.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.
This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead. You can use this parameter or resourceRequirements structure but not both.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using resourceRequirement. You can do this for EC2 resources.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using resourceRequirement. You can also do this for EC2 resources.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
" }, "executionRoleArn":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
" + "documentation":"The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
" }, "volumes":{ "shape":"Volumes", @@ -837,7 +837,7 @@ }, "environment":{ "shape":"EnvironmentVariables", - "documentation":"The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
" + "documentation":"The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
" }, "networkConfiguration":{ "shape":"NetworkConfiguration", - "documentation":"The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
" + "documentation":"The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
" }, "fargatePlatformConfiguration":{ "shape":"FargatePlatformConfiguration", - "documentation":"The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
" + "documentation":"The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
" } }, "documentation":"Container properties are used in job definitions to describe the container that's launched as part of a job.
" @@ -917,23 +917,23 @@ }, "type":{ "shape":"CEType", - "documentation":"The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
" + "documentation":"Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.
" }, "serviceRole":{ "shape":"String", - "documentation":"The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.
If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.
If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.
Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
" + "documentation":"The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
" } }, "documentation":"Contains the parameters for CreateComputeEnvironment.
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.
" + "documentation":"The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
" } }, "documentation":"Contains the parameters for CreateJobQueue.
A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
" + "documentation":"A list of up to 100 job definitions. Each entry in the list can either be an ARN of the form arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.
The path inside the container used to expose the host device. By default, the hostPath value is used.
The path inside the container that's used to expose the host device. By default, the hostPath value is used.
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
An object representing a container instance host device.
This object isn't applicable to jobs running on Fargate resources and shouldn't be provided.
An object representing a container instance host device.
This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
Whether or not to use the AWS Batch execution IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the AWS Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.
The authorization configuration details for the Amazon EFS file system.
" @@ -1240,22 +1240,22 @@ }, "rootDirectory":{ "shape":"String", - "documentation":"The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the Amazon EFS access point.
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
" + "documentation":"The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
" }, "authorizationConfig":{ "shape":"EFSAuthorizationConfig", "documentation":"The authorization configuration details for the Amazon EFS file system.
" } }, - "documentation":"This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide.
" + "documentation":"This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.
" }, "Ec2Configuration":{ "type":"structure", @@ -1263,14 +1263,14 @@ "members":{ "imageType":{ "shape":"ImageType", - "documentation":"The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI (ECS_AL1) is used. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
Amazon Linux 2− Default for all AWS Graviton-based instance families (for example, C6g, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non-AWS Graviton-based instance types.
Amazon Linux−Default for all non-GPU, non-AWS Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI (ECS_AL1) is used. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
Amazon Linux 2− Default for all Amazon Web Services Graviton-based instance families (for example, C6g, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.
Amazon Linux−Default for all non-GPU, non Amazon Web Services Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is currently ECS_AL1 (Amazon Linux) for non-GPU, non-Graviton instances. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs running on Fargate resources.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is currently ECS_AL1 (Amazon Linux) for non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs that are running on Fargate resources.
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
The AWS Fargate platform version where the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The platform configuration for jobs running on Fargate resources. For jobs that run on EC2 resources, you shouldn't specify this parameter.
" + "documentation":"The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.
" }, "Host":{ "type":"structure", @@ -1383,11 +1383,11 @@ }, "type":{ "shape":"String", - "documentation":"The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.
The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.
" + "documentation":"The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.
" }, "nodeProperties":{ "shape":"NodeProperties", @@ -1418,7 +1418,7 @@ "documentation":"The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
An object representing an AWS Batch job definition.
" + "documentation":"An object representing an Batch job definition.
" }, "JobDefinitionList":{ "type":"list", @@ -1436,14 +1436,14 @@ "members":{ "jobId":{ "shape":"String", - "documentation":"The job ID of the AWS Batch job associated with this dependency.
" + "documentation":"The job ID of the Batch job associated with this dependency.
" }, "type":{ "shape":"ArrayJobDependency", "documentation":"The type of the job dependency.
" } }, - "documentation":"An object representing an AWS Batch job dependency.
" + "documentation":"An object representing an Batch job dependency.
" }, "JobDependencyList":{ "type":"list", @@ -1478,7 +1478,7 @@ }, "status":{ "shape":"JobStatus", - "documentation":"The current status for the job.
If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
The current status for the job.
If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the Batch User Guide.
An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs running on Fargate resources.
An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
An object representing an AWS Batch job.
" + "documentation":"An object representing an Batch job.
" }, "JobDetailList":{ "type":"list", @@ -1595,10 +1595,10 @@ }, "tags":{ "shape":"TagrisTagsMap", - "documentation":"The tags applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.
" + "documentation":"The tags applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
" } }, - "documentation":"An object representing the details of an AWS Batch job queue.
" + "documentation":"An object representing the details of an Batch job queue.
" }, "JobQueueDetailList":{ "type":"list", @@ -1665,7 +1665,11 @@ }, "nodeProperties":{ "shape":"NodePropertiesSummary", - "documentation":"The node properties for a single node in a job summary list.
This isn't applicable to jobs running on Fargate resources.
The node properties for a single node in a job summary list.
This isn't applicable to jobs that are running on Fargate resources.
The Amazon Resource Name (ARN) of the job definition.
" } }, "documentation":"An object representing summary details of a job.
" @@ -1679,7 +1683,7 @@ "members":{ "attemptDurationSeconds":{ "shape":"Integer", - "documentation":"The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
The time duration in seconds (measured from the job attempt's startedAt timestamp) after which Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
An object representing a job timeout configuration.
" @@ -1698,6 +1702,20 @@ }, "documentation":"A key-value pair object.
" }, + "KeyValuesPair":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the filter. Filter names are case sensitive.
" + }, + "values":{ + "shape":"StringList", + "documentation":"The filter values.
" + } + }, + "documentation":"A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
After the compute environment is created, the launch template version used will not be changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.
Default: $Default.
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
After the compute environment is created, the launch template version that's used isn't changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.
Default: $Default.
An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.
This object isn't applicable to jobs running on Fargate resources.
An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.
This object isn't applicable to jobs that are running on Fargate resources.
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.
Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
The swap space parameters are only supported for job definitions using EC2 resources.
If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.
Consider the following when you use a per-container swap configuration.
Swap space must be enabled and allocated on the container instance for the containers to use.
The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
The swap space parameters are only supported for job definitions using EC2 resources.
If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
Linux-specific modifications that are applied to the container, such as details for device mappings.
" }, + "ListJobsFilterList":{ + "type":"list", + "member":{"shape":"KeyValuesPair"} + }, "ListJobsRequest":{ "type":"structure", "members":{ @@ -1763,7 +1785,7 @@ }, "jobStatus":{ "shape":"JobStatus", - "documentation":"The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.
The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.
The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter will match any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter will match any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) is not supported when the ARN is used.
The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC (midnight) on January 1, 1970.
Contains the parameters for ListJobs.
The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", + "documentation":"The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", "location":"uri", "locationName":"resourceArn" } @@ -1817,7 +1843,7 @@ "members":{ "logDriver":{ "shape":"LogDriver", - "documentation":"The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Jobs running on Fargate resources are restricted to the awslogs and splunk log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
" + "documentation":"The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.
" } }, "documentation":"Log configuration options to send to a custom log driver for the container.
" @@ -1875,10 +1901,10 @@ "members":{ "assignPublicIp":{ "shape":"AssignPublicIp", - "documentation":"Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is \"DISABLED\".
" + "documentation":"Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is \"DISABLED\".
" } }, - "documentation":"The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
" + "documentation":"The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
" }, "NetworkInterface":{ "type":"structure", @@ -1928,7 +1954,7 @@ "documentation":"The node property overrides for the job.
" } }, - "documentation":"Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use containerOverrides instead.
Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
This isn't applicable to jobs that are running on Fargate resources and shouldn't be provided; use containerOverrides instead.
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.
" + "documentation":"The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
" }, "tags":{ "shape":"TagrisTagsMap", - "documentation":"The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.
" + "documentation":"The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
" }, "platformCapabilities":{ "shape":"PlatformCapabilityList", @@ -2106,7 +2132,7 @@ "members":{ "value":{ "shape":"String", - "documentation":"The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
For jobs running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
GPUs are not available for jobs that are running on Fargate resources.
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.
For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.
VCPU = 0.25
VCPU = 0.25 or 0.5
VCPU = 0.25, 0.5, or 1
VCPU = 0.5, or 1
VCPU = 0.5, 1, or 2
VCPU = 1 or 2
VCPU = 1, 2, or 4
VCPU = 2 or 4
VCPU = 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
MEMORY = 512, 1024, or 2048
MEMORY = 1024, 2048, 3072, or 4096
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.
The retry strategy associated with a job. For more information, see Automated job retries in the AWS Batch User Guide.
" + "documentation":"The retry strategy associated with a job. For more information, see Automated job retries in the Batch User Guide.
" }, "Secret":{ "type":"structure", @@ -2161,10 +2187,10 @@ }, "valueFrom":{ "shape":"String", - "documentation":"The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
" + "documentation":"An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the Batch User Guide.
" }, "SecretList":{ "type":"list", @@ -2203,7 +2229,7 @@ }, "arrayProperties":{ "shape":"ArrayProperties", - "documentation":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
" + "documentation":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.
" }, "dependsOn":{ "shape":"JobDependencyList", @@ -2223,7 +2249,7 @@ }, "nodeOverrides":{ "shape":"NodeOverrides", - "documentation":"A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
" }, "tags":{ "shape":"TagrisTagsMap", - "documentation":"The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
" + "documentation":"The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
" } }, "documentation":"Contains the parameters for SubmitJob.
The Amazon Resource Name (ARN) of the resource that tags are added to. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", + "documentation":"The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagrisTagsMap", - "documentation":"The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
" + "documentation":"The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
" } } }, @@ -2325,11 +2351,11 @@ "members":{ "jobId":{ "shape":"String", - "documentation":"The AWS Batch job ID of the job to terminate.
" + "documentation":"The Batch job ID of the job to terminate.
" }, "reason":{ "shape":"String", - "documentation":"A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
" + "documentation":"A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.
" } }, "documentation":"Contains the parameters for TerminateJob.
The list of tmpfs volume mount options.
Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs running on Fargate resources.
The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs that are running on Fargate resources.
The soft limit for the ulimit type.
The ulimit settings to pass to the container.
This object isn't applicable to jobs running on Fargate resources.
The ulimit settings to pass to the container.
This object isn't applicable to jobs that are running on Fargate resources.
The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", + "documentation":"The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", "location":"uri", "locationName":"resourceArn" }, @@ -2428,15 +2454,15 @@ }, "state":{ "shape":"CEState", - "documentation":"The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
" + "documentation":"Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.
" }, "serviceRole":{ "shape":"String", - "documentation":"The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
Contains the parameters for UpdateComputeEnvironment.
Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
Contains the parameters for UpdateJobQueue.
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.
This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs running on Fargate resources must specify a platformVersion of at least 1.4.0.
This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.
A data volume used in a job's container properties.
" @@ -2513,5 +2539,5 @@ "member":{"shape":"Volume"} } }, - "documentation":"Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.
" + "documentation":"Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.
" } From 4be974803ed7a51682531a0800165f5a46ebea7d Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:59 +0000 Subject: [PATCH 07/14] Redshift Data API Service Update: Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction. --- ...eature-RedshiftDataAPIService-c4e58cd.json | 6 + .../codegen-resources/service-2.json | 261 +++++++++++++++--- 2 files changed, 234 insertions(+), 33 deletions(-) create mode 100644 .changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json diff --git a/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json b/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json new file mode 100644 index 000000000000..e603c97c167d --- /dev/null +++ b/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Redshift Data API Service", + "contributor": "", + "description": "Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction." +} diff --git a/services/redshiftdata/src/main/resources/codegen-resources/service-2.json b/services/redshiftdata/src/main/resources/codegen-resources/service-2.json index d0a4000bcc83..6ae75eaf9f79 100644 --- a/services/redshiftdata/src/main/resources/codegen-resources/service-2.json +++ b/services/redshiftdata/src/main/resources/codegen-resources/service-2.json @@ -13,6 +13,21 @@ "uid":"redshift-data-2019-12-20" }, "operations":{ + "BatchExecuteStatement":{ + "name":"BatchExecuteStatement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchExecuteStatementInput"}, + "output":{"shape":"BatchExecuteStatementOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ActiveStatementsExceededException"}, + {"shape":"BatchExecuteStatementException"} + ], + "documentation":"Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:
Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.
The number of active statements exceeds the limit.
", "exception":true }, + "BatchExecuteStatementException":{ + "type":"structure", + "required":[ + "Message", + "StatementId" + ], + "members":{ + "Message":{"shape":"String"}, + "StatementId":{ + "shape":"String", + "documentation":"Statement identifier of the exception.
" + } + }, + "documentation":"An SQL statement encountered an environmental error while running.
", + "exception":true, + "fault":true + }, + "BatchExecuteStatementInput":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "Database", + "Sqls" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"Location", + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" + }, + "Database":{ + "shape":"String", + "documentation":"The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" + }, + "DbUser":{ + "shape":"String", + "documentation":"The database user name. This parameter is required when authenticating using temporary credentials.
" + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" + }, + "Sqls":{ + "shape":"SqlList", + "documentation":"One or more SQL statements to run.
" + }, + "StatementName":{ + "shape":"StatementNameString", + "documentation":"The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
" + }, + "WithEvent":{ + "shape":"Boolean", + "documentation":"A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
" + } + } + }, + "BatchExecuteStatementOutput":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"Location", + "documentation":"The cluster identifier.
" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time (UTC) the statement was created.
" + }, + "Database":{ + "shape":"String", + "documentation":"The name of the database.
" + }, + "DbUser":{ + "shape":"String", + "documentation":"The database user name.
" + }, + "Id":{ + "shape":"StatementId", + "documentation":"The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.
The name or ARN of the secret that enables access to the database.
" + } + } + }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", @@ -174,8 +274,8 @@ "required":["Id"], "members":{ "Id":{ - "shape":"UUID", - "documentation":"The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.
A value that indicates whether the statement has a result set. The result set can be empty.
" }, "Id":{ - "shape":"UUID", + "shape":"StatementId", "documentation":"The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
" }, "QueryParameters":{ @@ -322,11 +422,11 @@ }, "ResultRows":{ "shape":"Long", - "documentation":"Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
" + "documentation":"Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
The size in bytes of the returned results.
" + "documentation":"The size in bytes of the returned results. A -1 indicates the value is null.
The status of the SQL statement being described. Status values are defined as follows:
ABORTED - The query run was stopped by the user.
ALL - A status value that includes all query statuses. This value can be used to filter results.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.
The SQL statements from a multiple statement run.
" + }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
" @@ -351,7 +455,7 @@ "members":{ "ClusterIdentifier":{ "shape":"Location", - "documentation":"The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
" + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "ConnectedDatabase":{ "shape":"String", @@ -379,7 +483,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
" + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" }, "Table":{ "shape":"String", @@ -428,16 +532,17 @@ "type":"structure", "required":[ "ClusterIdentifier", + "Database", "Sql" ], "members":{ "ClusterIdentifier":{ "shape":"Location", - "documentation":"The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
" + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "Database":{ "shape":"String", - "documentation":"The name of the database. This parameter is required when authenticating using temporary credentials.
" + "documentation":"The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "DbUser":{ "shape":"String", @@ -449,7 +554,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
" + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" }, "Sql":{ "shape":"StatementString", @@ -485,8 +590,8 @@ "documentation":"The database user name.
" }, "Id":{ - "shape":"UUID", - "documentation":"The identifier of the statement to be run. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
" + "shape":"StatementId", + "documentation":"The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
" }, "SecretArn":{ "shape":"SecretArn", @@ -534,8 +639,8 @@ "required":["Id"], "members":{ "Id":{ - "shape":"UUID", - "documentation":"The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by ExecuteStatment and ListStatements.
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
" + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "Database":{ "shape":"String", - "documentation":"The name of the database. This parameter is required when authenticating using temporary credentials.
" + "documentation":"The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "DbUser":{ "shape":"String", @@ -605,7 +713,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
" + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" } } }, @@ -631,7 +739,7 @@ "members":{ "ClusterIdentifier":{ "shape":"Location", - "documentation":"The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
" + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "ConnectedDatabase":{ "shape":"String", @@ -659,7 +767,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
" + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" } } }, @@ -698,7 +806,7 @@ }, "StatementName":{ "shape":"StatementNameString", - "documentation":"The name of the SQL statement specified as input to ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
" + "documentation":"The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
" }, "ConnectedDatabase":{ "shape":"String", @@ -757,7 +865,7 @@ }, "SecretArn":{ "shape":"SecretArn", - "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
" + "documentation":"The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
" }, "TablePattern":{ "shape":"String", @@ -817,6 +925,12 @@ "member":{"shape":"String"} }, "SecretArn":{"type":"string"}, + "SqlList":{ + "type":"list", + "member":{"shape":"StatementString"}, + "max":40, + "min":1 + }, "SqlParameter":{ "type":"structure", "required":[ @@ -853,9 +967,13 @@ "documentation":"The date and time (UTC) the statement was created.
" }, "Id":{ - "shape":"UUID", + "shape":"StatementId", "documentation":"The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
" }, + "IsBatchStatement":{ + "shape":"Boolean", + "documentation":"A value that indicates whether the statement is a batch query request.
" + }, "QueryParameters":{ "shape":"SqlParametersList", "documentation":"The parameters used in a SQL statement.
" @@ -864,6 +982,10 @@ "shape":"StatementString", "documentation":"The SQL statement.
" }, + "QueryStrings":{ + "shape":"StatementStringList", + "documentation":"One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.
" + }, "SecretArn":{ "shape":"SecretArn", "documentation":"The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
" @@ -883,6 +1005,10 @@ }, "documentation":"The SQL statement to run.
" }, + "StatementId":{ + "type":"string", + "pattern":"^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$" + }, "StatementList":{ "type":"list", "member":{"shape":"StatementData"} @@ -892,7 +1018,22 @@ "max":500, "min":0 }, + "StatementStatusString":{ + "type":"string", + "enum":[ + "SUBMITTED", + "PICKED", + "STARTED", + "FINISHED", + "ABORTED", + "FAILED" + ] + }, "StatementString":{"type":"string"}, + "StatementStringList":{ + "type":"list", + "member":{"shape":"StatementString"} + }, "StatusString":{ "type":"string", "enum":[ @@ -906,6 +1047,61 @@ ] }, "String":{"type":"string"}, + "SubStatementData":{ + "type":"structure", + "required":["Id"], + "members":{ + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time (UTC) the statement was created.
" + }, + "Duration":{ + "shape":"Long", + "documentation":"The amount of time in nanoseconds that the statement ran.
" + }, + "Error":{ + "shape":"String", + "documentation":"The error message from the cluster if the SQL statement encountered an error while running.
" + }, + "HasResultSet":{ + "shape":"Boolean", + "documentation":"A value that indicates whether the statement has a result set. The result set can be empty.
" + }, + "Id":{ + "shape":"StatementId", + "documentation":"The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.
The SQL statement text.
" + }, + "RedshiftQueryId":{ + "shape":"Long", + "documentation":"The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
" + }, + "ResultRows":{ + "shape":"Long", + "documentation":"Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
The size in bytes of the returned results. A -1 indicates the value is null.
The status of the SQL statement. An example is the that the SQL statement finished.
" + }, + "UpdatedAt":{ + "shape":"Timestamp", + "documentation":"The date and time (UTC) that the statement metadata was last updated.
" + } + }, + "documentation":"Information about an SQL statement.
" + }, + "SubStatementList":{ + "type":"list", + "member":{"shape":"SubStatementData"} + }, "TableList":{ "type":"list", "member":{"shape":"TableMember"} @@ -929,7 +1125,6 @@ "documentation":"The properties of a table.
" }, "Timestamp":{"type":"timestamp"}, - "UUID":{"type":"string"}, "ValidationException":{ "type":"structure", "members":{ @@ -943,5 +1138,5 @@ }, "bool":{"type":"boolean"} }, - "documentation":"You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds.
For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API in the Amazon Redshift Cluster Management Guide.
" + "documentation":"You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.
For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API in the Amazon Redshift Cluster Management Guide.
" } From f0cb56d67f37112b5d5fae1163f34fbc192ec571 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:56 +0000 Subject: [PATCH 08/14] AWS Shield Update: Change name of DDoS Response Team (DRT) to Shield Response Team (SRT) --- .../feature-AWSShield-67ae7d6.json | 6 + .../codegen-resources/service-2.json | 110 +++++++++--------- 2 files changed, 61 insertions(+), 55 deletions(-) create mode 100644 .changes/next-release/feature-AWSShield-67ae7d6.json diff --git a/.changes/next-release/feature-AWSShield-67ae7d6.json b/.changes/next-release/feature-AWSShield-67ae7d6.json new file mode 100644 index 000000000000..d13d0ffb855a --- /dev/null +++ b/.changes/next-release/feature-AWSShield-67ae7d6.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Shield", + "contributor": "", + "description": "Change name of DDoS Response Team (DRT) to Shield Response Team (SRT)" +} diff --git a/services/shield/src/main/resources/codegen-resources/service-2.json b/services/shield/src/main/resources/codegen-resources/service-2.json index c35e4190b55a..f4fce91164b4 100644 --- a/services/shield/src/main/resources/codegen-resources/service-2.json +++ b/services/shield/src/main/resources/codegen-resources/service-2.json @@ -31,7 +31,7 @@ {"shape":"OptimisticLockException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.
The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
" + "documentation":"Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" }, "AssociateProactiveEngagementDetails":{ "name":"AssociateProactiveEngagementDetails", @@ -83,7 +83,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"OptimisticLockException"} ], - "documentation":"Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.
This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.
This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.
Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
" + "documentation":"Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the WAF console. For more information see Getting Started with Shield Advanced and Add Shield Advanced Protection to more Amazon Web Services Resources.
" }, "CreateProtectionGroup":{ "name":"CreateProtectionGroup", @@ -135,7 +135,7 @@ {"shape":"InternalErrorException"}, {"shape":"ResourceAlreadyExistsException"} ], - "documentation":"Activates AWS Shield Advanced for an account.
When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
Activates Shield Advanced for an account.
When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
Deletes an AWS Shield Advanced Protection.
" + "documentation":"Deletes an Shield Advanced Protection.
" }, "DeleteProtectionGroup":{ "name":"DeleteProtectionGroup", @@ -180,7 +180,7 @@ {"shape":"LockedSubscriptionException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
", + "documentation":"Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
", "deprecated":true }, "DescribeAttack":{ @@ -208,7 +208,7 @@ "errors":[ {"shape":"InternalErrorException"} ], - "documentation":"Provides information about the number and type of attacks AWS Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC.
The time range indicates the period covered by the attack statistics data items.
" + "documentation":"Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC.
The time range indicates the period covered by the attack statistics data items.
" }, "DescribeDRTAccess":{ "name":"DescribeDRTAccess", @@ -222,7 +222,7 @@ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
" + "documentation":"Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
" }, "DescribeEmergencyContactSettings":{ "name":"DescribeEmergencyContactSettings", @@ -236,7 +236,7 @@ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
" + "documentation":"A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
" }, "DescribeProtection":{ "name":"DescribeProtection", @@ -279,7 +279,7 @@ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Provides details about the AWS Shield Advanced subscription for an account.
" + "documentation":"Provides details about the Shield Advanced subscription for an account.
" }, "DisableProactiveEngagement":{ "name":"DisableProactiveEngagement", @@ -296,7 +296,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"OptimisticLockException"} ], - "documentation":"Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
" + "documentation":"Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
" }, "DisassociateDRTLogBucket":{ "name":"DisassociateDRTLogBucket", @@ -314,7 +314,7 @@ {"shape":"OptimisticLockException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
Removes the DDoS Response Team's (DRT) access to your AWS account.
To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the SRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
" + "documentation":"Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and mitigation.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
" }, "EnableProactiveEngagement":{ "name":"EnableProactiveEngagement", @@ -363,7 +363,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"OptimisticLockException"} ], - "documentation":"Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
" + "documentation":"Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
" }, "GetSubscriptionState":{ "name":"GetSubscriptionState", @@ -451,7 +451,7 @@ {"shape":"InvalidResourceException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield.
" + "documentation":"Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
" }, "TagResource":{ "name":"TagResource", @@ -467,7 +467,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Adds or updates tags for a resource in AWS Shield.
" + "documentation":"Adds or updates tags for a resource in Shield.
" }, "UntagResource":{ "name":"UntagResource", @@ -483,7 +483,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Removes tags from a resource in AWS Shield.
" + "documentation":"Removes tags from a resource in Shield.
" }, "UpdateEmergencyContactSettings":{ "name":"UpdateEmergencyContactSettings", @@ -499,7 +499,7 @@ {"shape":"OptimisticLockException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
" + "documentation":"Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
" }, "UpdateProtectionGroup":{ "name":"UpdateProtectionGroup", @@ -549,7 +549,7 @@ "members":{ "message":{"shape":"errorMessage"} }, - "documentation":"In order to grant the necessary access to the DDoS Response Team (DRT), the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.
In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an Amazon Web Services Service.
The Amazon S3 bucket that contains your AWS WAF logs.
" + "documentation":"The Amazon S3 bucket that contains the logs that you want to share.
" } } }, @@ -573,7 +573,7 @@ "members":{ "RoleArn":{ "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.
The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.
To enable proactive engagement, the contact list must include at least one phone number.
The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.
The array of AttackProperty objects.
" + "documentation":"The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
" }, "Mitigations":{ "shape":"MitigationList", @@ -679,26 +679,26 @@ "members":{ "AttackLayer":{ "shape":"AttackLayer", - "documentation":"The type of distributed denial of service (DDoS) event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
For infrastructure layer events (L3 and L4 events) after January 25, 2021, you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide.
" }, "AttackPropertyIdentifier":{ "shape":"AttackPropertyIdentifier", - "documentation":"Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback DDoS attacks.
Defines the Shield event property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback events.
The array of contributor objects that includes the top five contributors to an attack.
" + "documentation":"Contributor objects for the top five contributors to a Shield event.
" }, "Unit":{ "shape":"Unit", - "documentation":"The unit of the Value of the contributions.
The unit used for the Contributor Value property.
The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.
The total contributions made to this Shield event by all contributors.
" } }, - "documentation":"Details of the described attack.
" + "documentation":"Details of a Shield event. This is provided as part of an AttackDetail.
" }, "AttackPropertyIdentifier":{ "type":"string", @@ -848,7 +848,7 @@ }, "Aggregation":{ "shape":"ProtectionGroupAggregation", - "documentation":"Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include CloudFront distributions and origin resources for CloudFront distributions.
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.
The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
For an Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
For an Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.
" + "documentation":"The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.
" }, "LogBucketList":{ "shape":"LogBucketList", - "documentation":"The list of Amazon S3 buckets accessed by the DRT.
" + "documentation":"The list of Amazon S3 buckets accessed by the SRT.
" } } }, @@ -1021,7 +1021,7 @@ "members":{ "EmergencyContactList":{ "shape":"EmergencyContactList", - "documentation":"A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
" + "documentation":"A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
" } } }, @@ -1041,7 +1041,7 @@ "members":{ "ProtectionGroup":{ "shape":"ProtectionGroup", - "documentation":"A grouping of protected resources that you and AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
" + "documentation":"A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
" } } }, @@ -1054,7 +1054,7 @@ }, "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.
The ARN (Amazon Resource Name) of the Amazon Web Services resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.
The AWS Shield Advanced subscription details for an account.
" + "documentation":"The Shield Advanced subscription details for an account.
" } } }, @@ -1097,7 +1097,7 @@ "members":{ "LogBucket":{ "shape":"LogBucket", - "documentation":"The Amazon S3 bucket that contains your AWS WAF logs.
" + "documentation":"The Amazon S3 bucket that contains the logs that you want to share.
" } } }, @@ -1166,7 +1166,7 @@ "documentation":"Additional notes regarding the contact.
" } }, - "documentation":"Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
" + "documentation":"Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
" }, "EmergencyContactList":{ "type":"list", @@ -1357,7 +1357,7 @@ }, "NextToken":{ "shape":"Token", - "documentation":"If you specify a value for MaxResults and you have more protection groups than the value of MaxResults, AWS Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
If you specify a value for MaxResults and you have more protection groups than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
Shield Advanced might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, Shield Advanced will always also return a NextToken.
If you specify a value for MaxResults and you have more Protections than the value of MaxResults, Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
Shield Advanced might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, Shield Advanced will always also return a NextToken.
If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, AWS Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
If you specify a value for MaxResults and you have more resources in the protection group than the value of MaxResults, Shield Advanced returns this token that you can use in your next request, to get the next batch of objects.
The ARN (Amazon Resource Name) of the AWS resource that is protected.
" + "documentation":"The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
" }, "HealthCheckIds":{ "shape":"HealthCheckIds", @@ -1561,7 +1561,7 @@ }, "Aggregation":{ "shape":"ProtectionGroupAggregation", - "documentation":"Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include CloudFront distributions and origin resources for CloudFront distributions.
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.
The ARN (Amazon Resource Name) of the protection group.
" } }, - "documentation":"A grouping of protected resources that you and AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
" + "documentation":"A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
" }, "ProtectionGroupAggregation":{ "type":"string", @@ -1773,7 +1773,7 @@ }, "TimeCommitmentInSeconds":{ "shape":"DurationInSeconds", - "documentation":"The length, in seconds, of the AWS Shield Advanced subscription for the account.
" + "documentation":"The length, in seconds, of the Shield Advanced subscription for the account.
" }, "AutoRenew":{ "shape":"AutoRenew", @@ -1785,7 +1785,7 @@ }, "ProactiveEngagementStatus":{ "shape":"ProactiveEngagementStatus", - "documentation":"If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
If DISABLED, the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.
If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
The ARN (Amazon Resource Name) of the subscription.
" } }, - "documentation":"Information about the AWS Shield Advanced subscription for an account.
" + "documentation":"Information about the Shield Advanced subscription for an account.
" }, "SubscriptionLimits":{ "type":"structure", @@ -1888,7 +1888,7 @@ "documentation":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.
" } }, - "documentation":"A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
" + "documentation":"A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
" }, "TagKey":{ "type":"string", @@ -1995,7 +1995,7 @@ "members":{ "EmergencyContactList":{ "shape":"EmergencyContactList", - "documentation":"A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
" + "documentation":"A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
" } } }, @@ -2018,7 +2018,7 @@ }, "Aggregation":{ "shape":"ProtectionGroupAggregation", - "documentation":"Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include CloudFront distributions and origin resources for CloudFront distributions.
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.
This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.
" + "documentation":"This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
" } From 4472b28fd726169f09449de80cfc90db34be9b5d Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:57 +0000 Subject: [PATCH 09/14] Amazon Lex Model Building V2 Update: Add waiters that automatically poll for resource status for asynchronous operations, such as building a bot --- ...ture-AmazonLexModelBuildingV2-77f6e9c.json | 6 + .../codegen-resources/waiters-2.json | 255 ++++++++++++++++++ 2 files changed, 261 insertions(+) create mode 100644 .changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json create mode 100644 services/lexmodelsv2/src/main/resources/codegen-resources/waiters-2.json diff --git a/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json b/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json new file mode 100644 index 000000000000..0f0798207efb --- /dev/null +++ b/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Lex Model Building V2", + "contributor": "", + "description": "Add waiters that automatically poll for resource status for asynchronous operations, such as building a bot" +} diff --git a/services/lexmodelsv2/src/main/resources/codegen-resources/waiters-2.json b/services/lexmodelsv2/src/main/resources/codegen-resources/waiters-2.json new file mode 100644 index 000000000000..1ec96048eca8 --- /dev/null +++ b/services/lexmodelsv2/src/main/resources/codegen-resources/waiters-2.json @@ -0,0 +1,255 @@ +{ + "version":2, + "waiters":{ + "BotAvailable":{ + "delay":10, + "operation":"DescribeBot", + "maxAttempts":35, + "description":"Wait until a bot is available", + "acceptors":[ + { + "expected":"Available", + "matcher":"path", + "state":"success", + "argument":"botStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botStatus" + }, + { + "expected":"Inactive", + "matcher":"path", + "state":"failure", + "argument":"botStatus" + } + ] + }, + "BotAliasAvailable":{ + "delay":10, + "operation":"DescribeBotAlias", + "maxAttempts":35, + "description":"Wait until a bot alias is available", + "acceptors":[ + { + "expected":"Available", + "matcher":"path", + "state":"success", + "argument":"botAliasStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botAliasStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botAliasStatus" + } + ] + }, + "BotExportCompleted":{ + "delay":10, + "operation":"DescribeExport", + "maxAttempts":35, + "description":"Wait until a bot has been exported", + "acceptors":[ + { + "expected":"Completed", + "matcher":"path", + "state":"success", + "argument":"exportStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"exportStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"exportStatus" + } + ] + }, + "BotImportCompleted":{ + "delay":10, + "operation":"DescribeImport", + "maxAttempts":35, + "description":"Wait until a bot has been imported", + "acceptors":[ + { + "expected":"Completed", + "matcher":"path", + "state":"success", + "argument":"importStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"importStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"importStatus" + } + ] + }, + "BotLocaleBuilt":{ + "delay":10, + "operation":"DescribeBotLocale", + "maxAttempts":35, + "description":"Wait until a bot locale is built", + "acceptors":[ + { + "expected":"Built", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + }, + { + "expected":"NotBuilt", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + } + ] + }, + "BotLocaleExpressTestingAvailable":{ + "delay":10, + "operation":"DescribeBotLocale", + "maxAttempts":35, + "description":"Wait until a bot locale build is ready for express testing", + "acceptors":[ + { + "expected":"Built", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"ReadyExpressTesting", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + }, + { + "expected":"NotBuilt", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + } + ] + }, + "BotVersionAvailable":{ + "delay":10, + "operation":"DescribeBotVersion", + "maxAttempts":35, + "description":"Wait until a bot version is available", + "acceptors":[ + { + "expected":"Available", + "matcher":"path", + "state":"success", + "argument":"botStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botStatus" + }, + { + "state":"retry", + "matcher":"status", + "expected":404 + } + ] + }, + "BotLocaleCreated":{ + "delay":10, + "operation":"DescribeBotLocale", + "maxAttempts":35, + "description":"Wait unit a bot locale is created", + "acceptors":[ + { + "expected":"Built", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"ReadyExpressTesting", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"NotBuilt", + "matcher":"path", + "state":"success", + "argument":"botLocaleStatus" + }, + { + "expected":"Deleting", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + }, + { + "expected":"Failed", + "matcher":"path", + "state":"failure", + "argument":"botLocaleStatus" + } + ] + } + } +} + From a436e91eaa3022427829d0e8c0bbba0b2c9152d8 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:07:58 +0000 Subject: [PATCH 10/14] AWS Route53 Recovery Control Config Update: Amazon Route 53 Application Recovery Controller's routing control - Routing Control Configuration APIs help you create and delete clusters, control panels, routing controls and safety rules. State changes (On/Off) of routing controls are not part of configuration APIs. --- ...SRoute53RecoveryControlConfig-a53438f.json | 6 + services/route53recoverycontrolconfig/pom.xml | 60 + .../codegen-resources/paginators-1.json | 29 + .../codegen-resources/service-2.json | 1892 +++++++++++++++++ .../codegen-resources/waiters-2.json | 152 ++ 5 files changed, 2139 insertions(+) create mode 100644 .changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json create mode 100644 services/route53recoverycontrolconfig/pom.xml create mode 100644 services/route53recoverycontrolconfig/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/route53recoverycontrolconfig/src/main/resources/codegen-resources/service-2.json create mode 100644 services/route53recoverycontrolconfig/src/main/resources/codegen-resources/waiters-2.json diff --git a/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json b/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json new file mode 100644 index 000000000000..dc61b763563d --- /dev/null +++ b/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Route53 Recovery Control Config", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Configuration APIs help you create and delete clusters, control panels, routing controls and safety rules. State changes (On/Off) of routing controls are not part of configuration APIs." +} diff --git a/services/route53recoverycontrolconfig/pom.xml b/services/route53recoverycontrolconfig/pom.xml new file mode 100644 index 000000000000..5d6670f47e8b --- /dev/null +++ b/services/route53recoverycontrolconfig/pom.xml @@ -0,0 +1,60 @@ + + + +200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "ServiceQuotaExceededException", + "documentation": "402 response
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the Amazon Route 53 Application Recovery Controller cluster data plane.
" + }, + "CreateControlPanel": { + "name": "CreateControlPanel", + "http": { + "method": "POST", + "requestUri": "/controlpanel", + "responseCode": 200 + }, + "input": { + "shape": "CreateControlPanelRequest" + }, + "output": { + "shape": "CreateControlPanelResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "ServiceQuotaExceededException", + "documentation": "402 response
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region.
" + }, + "CreateRoutingControl": { + "name": "CreateRoutingControl", + "http": { + "method": "POST", + "requestUri": "/routingcontrol", + "responseCode": 200 + }, + "input": { + "shape": "CreateRoutingControlRequest" + }, + "output": { + "shape": "CreateRoutingControlResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "ServiceQuotaExceededException", + "documentation": "402 response
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Creates a new routing control.
A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.
To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
" + }, + "CreateSafetyRule": { + "name": "CreateSafetyRule", + "http": { + "method": "POST", + "requestUri": "/safetyrule", + "responseCode": 200 + }, + "input": { + "shape": "CreateSafetyRuleRequest" + }, + "output": { + "shape": "CreateSafetyRuleResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + } + ], + "documentation": "Creates a safety rule in a control panel. Safety rules let you add safeguards around enabling and disabling routing controls, to help prevent unexpected outcomes.
There are two types of safety rules: assertion rules and gating rules.
Assertion rule: An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
Gating rule: A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
" + }, + "DeleteCluster": { + "name": "DeleteCluster", + "http": { + "method": "DELETE", + "requestUri": "/cluster/{ClusterArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteClusterRequest" + }, + "output": { + "shape": "DeleteClusterResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Delete a cluster.
" + }, + "DeleteControlPanel": { + "name": "DeleteControlPanel", + "http": { + "method": "DELETE", + "requestUri": "/controlpanel/{ControlPanelArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteControlPanelRequest" + }, + "output": { + "shape": "DeleteControlPanelResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Deletes a control panel.
" + }, + "DeleteRoutingControl": { + "name": "DeleteRoutingControl", + "http": { + "method": "DELETE", + "requestUri": "/routingcontrol/{RoutingControlArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteRoutingControlRequest" + }, + "output": { + "shape": "DeleteRoutingControlResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Deletes a routing control.
" + }, + "DeleteSafetyRule": { + "name": "DeleteSafetyRule", + "http": { + "method": "DELETE", + "requestUri": "/safetyrule/{SafetyRuleArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteSafetyRuleRequest" + }, + "output": { + "shape": "DeleteSafetyRuleResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + } + ], + "documentation": "Deletes a safety rule.
/>" + }, + "DescribeCluster": { + "name": "DescribeCluster", + "http": { + "method": "GET", + "requestUri": "/cluster/{ClusterArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeClusterRequest" + }, + "output": { + "shape": "DescribeClusterResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
" + }, + "DescribeControlPanel": { + "name": "DescribeControlPanel", + "http": { + "method": "GET", + "requestUri": "/controlpanel/{ControlPanelArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeControlPanelRequest" + }, + "output": { + "shape": "DescribeControlPanelResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Displays details about a control panel.
" + }, + "DescribeRoutingControl": { + "name": "DescribeRoutingControl", + "http": { + "method": "GET", + "requestUri": "/routingcontrol/{RoutingControlArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeRoutingControlRequest" + }, + "output": { + "shape": "DescribeRoutingControlResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
" + }, + "DescribeSafetyRule": { + "name": "DescribeSafetyRule", + "http": { + "method": "GET", + "requestUri": "/safetyrule/{SafetyRuleArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeSafetyRuleRequest" + }, + "output": { + "shape": "DescribeSafetyRuleResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + } + ], + "documentation": "Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.
" + }, + "ListAssociatedRoute53HealthChecks": { + "name": "ListAssociatedRoute53HealthChecks", + "http": { + "method": "GET", + "requestUri": "/routingcontrol/{RoutingControlArn}/associatedRoute53HealthChecks", + "responseCode": 200 + }, + "input": { + "shape": "ListAssociatedRoute53HealthChecksRequest" + }, + "output": { + "shape": "ListAssociatedRoute53HealthChecksResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + } + ], + "documentation": "Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
" + }, + "ListClusters": { + "name": "ListClusters", + "http": { + "method": "GET", + "requestUri": "/cluster", + "responseCode": 200 + }, + "input": { + "shape": "ListClustersRequest" + }, + "output": { + "shape": "ListClustersResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + } + ], + "documentation": "Returns an array of all the clusters in an account.
" + }, + "ListControlPanels": { + "name": "ListControlPanels", + "http": { + "method": "GET", + "requestUri": "/controlpanels", + "responseCode": 200 + }, + "input": { + "shape": "ListControlPanelsRequest" + }, + "output": { + "shape": "ListControlPanelsResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + } + ], + "documentation": "Returns an array of control panels for a cluster.
" + }, + "ListRoutingControls": { + "name": "ListRoutingControls", + "http": { + "method": "GET", + "requestUri": "/controlpanel/{ControlPanelArn}/routingcontrols", + "responseCode": 200 + }, + "input": { + "shape": "ListRoutingControlsRequest" + }, + "output": { + "shape": "ListRoutingControlsResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + } + ], + "documentation": "Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
" + }, + "ListSafetyRules": { + "name": "ListSafetyRules", + "http": { + "method": "GET", + "requestUri": "/controlpanel/{ControlPanelArn}/safetyrules", + "responseCode": 200 + }, + "input": { + "shape": "ListSafetyRulesRequest" + }, + "output": { + "shape": "ListSafetyRulesResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + } + ], + "documentation": "List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
" + }, + "UpdateControlPanel": { + "name": "UpdateControlPanel", + "http": { + "method": "PUT", + "requestUri": "/controlpanel", + "responseCode": 200 + }, + "input": { + "shape": "UpdateControlPanelRequest" + }, + "output": { + "shape": "UpdateControlPanelResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
" + }, + "UpdateRoutingControl": { + "name": "UpdateRoutingControl", + "http": { + "method": "PUT", + "requestUri": "/routingcontrol", + "responseCode": 200 + }, + "input": { + "shape": "UpdateRoutingControlRequest" + }, + "output": { + "shape": "UpdateRoutingControlResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + }, + { + "shape": "AccessDeniedException", + "documentation": "403 response - AccessDeniedException. You do not hace sufficient access to perform this action.
" + }, + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ThrottlingException", + "documentation": "429 response - LimitExceededException or TooManyRequestsException.
" + }, + { + "shape": "ConflictException", + "documentation": "409 response - ConflictException. You might be using a predefined variable.
" + } + ], + "documentation": "Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
" + }, + "UpdateSafetyRule": { + "name": "UpdateSafetyRule", + "http": { + "method": "PUT", + "requestUri": "/safetyrule", + "responseCode": 200 + }, + "input": { + "shape": "UpdateSafetyRuleRequest" + }, + "output": { + "shape": "UpdateSafetyRuleResponse", + "documentation": "200 response - Success.
" + }, + "errors": [ + { + "shape": "ResourceNotFoundException", + "documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
" + }, + { + "shape": "ValidationException", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
" + }, + { + "shape": "InternalServerException", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
" + } + ], + "documentation": "Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel. You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new safety rule.
" + } + }, + "shapes": { + "AccessDeniedException": { + "type": "structure", + "documentation": "403 response - AccessDeniedException. You do not have sufficient access to perform this action.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 403 + } + }, + "AssertionRule": { + "type": "structure", + "members": { + "AssertedControls": { + "shape": "__listOf__string", + "documentation": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
" + }, + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "Name of the assertion rule. You can use any non-white space character in the name.
" + }, + "RuleConfig": { + "shape": "RuleConfig", + "documentation": "The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
" + }, + "SafetyRuleArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the assertion rule.
" + }, + "Status": { + "shape": "Status", + "documentation": "The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
", + "required": [ + "Status", + "ControlPanelArn", + "SafetyRuleArn", + "AssertedControls", + "RuleConfig", + "WaitPeriodMs", + "Name" + ] + }, + "AssertionRuleUpdate": { + "type": "structure", + "members": { + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the assertion rule. You can use any non-white space character in the name.
" + }, + "SafetyRuleArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the assertion rule.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "An update to an assertion rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
", + "required": [ + "SafetyRuleArn", + "WaitPeriodMs", + "Name" + ] + }, + "Cluster": { + "type": "structure", + "documentation": "A cluster is a set of five consensus-forming Regional endpoints that represent the infrastructure that hosts your routing controls. Typically, you host together on one cluster all of the routing controls for your applications.
", + "members": { + "ClusterArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the cluster.
" + }, + "ClusterEndpoints": { + "shape": "__listOfClusterEndpoint", + "documentation": "Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the cluster.
" + }, + "Status": { + "shape": "Status", + "documentation": "Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
" + } + } + }, + "ClusterEndpoint": { + "type": "structure", + "members": { + "Endpoint": { + "shape": "__stringMin1Max128", + "documentation": "A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
" + }, + "Region": { + "shape": "__stringMin1Max32", + "documentation": "The Amazon Web Services Region for a cluster endpoint.
" + } + }, + "documentation": "A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
" + }, + "ConflictException": { + "type": "structure", + "documentation": "409 response - ConflictException.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 409 + } + }, + "ControlPanel": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the cluster that includes the control panel.
" + }, + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel.
" + }, + "DefaultControlPanel": { + "shape": "__boolean", + "documentation": "A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the control panel. You can use any non-white space character in the name.
" + }, + "RoutingControlCount": { + "shape": "__integer", + "documentation": "The number of routing controls in the control panel.
" + }, + "Status": { + "shape": "Status", + "documentation": "The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
" + } + }, + "documentation": "A control panel represents a group of routing controls that can be changed together in a single transaction.
" + }, + "CreateClusterRequest": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "__stringMax64", + "idempotencyToken": true, + "documentation": "Unique client idempotency token.
" + }, + "ClusterName": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the cluster.
" + } + }, + "documentation": "Creates a cluster.
", + "required": [ + "ClusterName" + ] + }, + "CreateClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Cluster", + "documentation": "The cluster that was created.
" + } + } + }, + "CreateControlPanelRequest": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "__stringMax64", + "documentation": "Unique client idempotency token.
", + "idempotencyToken": true + }, + "ClusterArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the cluster for the control panel.
" + }, + "ControlPanelName": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the control panel.
" + } + }, + "documentation": "The details of the control panel that you're creating.
", + "required": [ + "ClusterArn", + "ControlPanelName" + ] + }, + "CreateControlPanelResponse": { + "type": "structure", + "members": { + "ControlPanel": { + "shape": "ControlPanel", + "documentation": "Information about a control panel.
" + } + } + }, + "CreateRoutingControlRequest": { + "type": "structure", + "members": { + "ClientToken": { + "shape": "__stringMax64", + "documentation": "Unique client idempotency token.
", + "idempotencyToken": true + }, + "ClusterArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the cluster that includes the routing control.
" + }, + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
" + }, + "RoutingControlName": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the routing control.
" + } + }, + "documentation": "The details of the routing control that you're creating.
", + "required": [ + "ClusterArn", + "RoutingControlName" + ] + }, + "CreateRoutingControlResponse": { + "type": "structure", + "members": { + "RoutingControl": { + "shape": "RoutingControl", + "documentation": "The routing control that is created.
" + } + } + }, + "CreateSafetyRuleRequest": { + "type": "structure", + "members": { + "AssertionRule": { + "shape": "NewAssertionRule" + }, + "ClientToken": { + "shape": "__stringMax64", + "documentation": "Unique client idempotency token.
", + "idempotencyToken": true + }, + "GatingRule": { + "shape": "NewGatingRule" + } + }, + "documentation": "The request body that you include when you create a safety rule.
" + }, + "CreateSafetyRuleResponse": { + "type": "structure", + "members": { + "AssertionRule": { + "shape": "AssertionRule" + }, + "GatingRule": { + "shape": "GatingRule" + } + } + }, + "DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "ClusterArn", + "documentation": "The Amazon Resource Name (ARN) of the cluster that you're deleting.
" + } + }, + "required": [ + "ClusterArn" + ] + }, + "DeleteClusterResponse": { + "type": "structure", + "members": {} + }, + "DeleteControlPanelRequest": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "location": "uri", + "locationName": "ControlPanelArn", + "documentation": "The Amazon Resource Name (ARN) of the control panel that you're deleting.
" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "DeleteControlPanelResponse": { + "type": "structure", + "members": {} + }, + "DeleteRoutingControlRequest": { + "type": "structure", + "members": { + "RoutingControlArn": { + "shape": "__string", + "location": "uri", + "locationName": "RoutingControlArn", + "documentation": "The Amazon Resource Name (ARN) of the routing control that you're deleting.
" + } + }, + "required": [ + "RoutingControlArn" + ] + }, + "DeleteRoutingControlResponse": { + "type": "structure", + "members": {} + }, + "DeleteSafetyRuleRequest": { + "type": "structure", + "members": { + "SafetyRuleArn": { + "shape": "__string", + "location": "uri", + "locationName": "SafetyRuleArn", + "documentation": "The request body that you include when you update a safety rule.
" + } + }, + "required": [ + "SafetyRuleArn" + ] + }, + "DeleteSafetyRuleResponse": { + "type": "structure", + "members": {} + }, + "DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "ClusterArn", + "documentation": "The Amazon Resource Name (ARN) of the cluster that you're getting details for.
" + } + }, + "required": [ + "ClusterArn" + ] + }, + "DescribeClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "shape": "Cluster", + "documentation": "The cluster for the DescribeCluster request.
" + } + } + }, + "DescribeControlPanelRequest": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "location": "uri", + "locationName": "ControlPanelArn", + "documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting details for.
" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "DescribeControlPanelResponse": { + "type": "structure", + "members": { + "ControlPanel": { + "shape": "ControlPanel", + "documentation": "Information about the control panel.
" + } + } + }, + "DescribeRoutingControlRequest": { + "type": "structure", + "members": { + "RoutingControlArn": { + "shape": "__string", + "location": "uri", + "locationName": "RoutingControlArn", + "documentation": "The Amazon Resource Name (ARN) of the routing control that you're getting details for.
" + } + }, + "required": [ + "RoutingControlArn" + ] + }, + "DescribeRoutingControlResponse": { + "type": "structure", + "members": { + "RoutingControl": { + "shape": "RoutingControl", + "documentation": "Information about the routing control.
" + } + } + }, + "DescribeSafetyRuleRequest": { + "type": "structure", + "members": { + "SafetyRuleArn": { + "shape": "__string", + "location": "uri", + "locationName": "SafetyRuleArn", + "documentation": "The request body that you include when you update a safety rule.
" + } + }, + "required": [ + "SafetyRuleArn" + ] + }, + "DescribeSafetyRuleResponse": { + "type": "structure", + "members": { + "AssertionRule": { + "shape": "AssertionRule" + }, + "GatingRule": { + "shape": "GatingRule" + } + } + }, + "GatingRule": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel.
" + }, + "GatingControls": { + "shape": "__listOf__string", + "documentation": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name for the gating rule.
" + }, + "RuleConfig": { + "shape": "RuleConfig", + "documentation": "The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
" + }, + "SafetyRuleArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the gating rule.
" + }, + "Status": { + "shape": "Status", + "documentation": "The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
" + }, + "TargetControls": { + "shape": "__listOf__string", + "documentation": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
", + "required": [ + "Status", + "TargetControls", + "ControlPanelArn", + "SafetyRuleArn", + "GatingControls", + "RuleConfig", + "WaitPeriodMs", + "Name" + ] + }, + "GatingRuleUpdate": { + "type": "structure", + "members": { + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name for the gating rule.
" + }, + "SafetyRuleArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the gating rule.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "Update to a gating rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
", + "required": [ + "SafetyRuleArn", + "WaitPeriodMs", + "Name" + ] + }, + "InternalServerException": { + "type": "structure", + "documentation": "500 response - InternalServiceError. Temporary service error. Retry the request.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 500 + } + }, + "ListAssociatedRoute53HealthChecksRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "MaxResults", + "documentation": "The number of objects that you want to return with this call.
" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "NextToken", + "documentation": "The token that identifies which batch of results you want to see.
" + }, + "RoutingControlArn": { + "shape": "__string", + "location": "uri", + "locationName": "RoutingControlArn", + "documentation": "The Amazon Resource Name (ARN) of the routing control that you're getting details for.
" + } + }, + "required": [ + "RoutingControlArn" + ] + }, + "ListAssociatedRoute53HealthChecksResponse": { + "type": "structure", + "members": { + "HealthCheckIds": { + "shape": "__listOf__string", + "documentation": "Identifiers for the health checks.
" + }, + "NextToken": { + "shape": "__stringMax8096", + "documentation": "The token that identifies which batch of results you want to see.
" + } + } + }, + "ListClustersRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "MaxResults", + "documentation": "The number of objects that you want to return with this call.
" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "NextToken", + "documentation": "The token that identifies which batch of results you want to see.
" + } + } + }, + "ListClustersResponse": { + "type": "structure", + "members": { + "Clusters": { + "shape": "__listOfCluster", + "documentation": "An array of the clusters in an account.
" + }, + "NextToken": { + "shape": "__stringMax8096", + "documentation": "The token that identifies which batch of results you want to see.
" + } + } + }, + "ListControlPanelsRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "querystring", + "locationName": "ClusterArn", + "documentation": "The Amazon Resource Name (ARN) of a cluster.
" + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "MaxResults", + "documentation": "The number of objects that you want to return with this call.
" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "NextToken", + "documentation": "The token that identifies which batch of results you want to see.
" + } + } + }, + "ListControlPanelsResponse": { + "type": "structure", + "members": { + "ControlPanels": { + "shape": "__listOfControlPanel", + "documentation": "The result of a successful ListControlPanel request.
" + }, + "NextToken": { + "shape": "__stringMax8096", + "documentation": "The token that identifies which batch of results you want to see.
" + } + } + }, + "ListRoutingControlsRequest": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "location": "uri", + "locationName": "ControlPanelArn", + "documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting routing control details for.
" + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "MaxResults", + "documentation": "The number of objects that you want to return with this call.
" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "NextToken", + "documentation": "The token that identifies which batch of results you want to see.
" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "ListRoutingControlsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__stringMax8096", + "documentation": "The token that identifies which batch of results you want to see.
" + }, + "RoutingControls": { + "shape": "__listOfRoutingControl", + "documentation": "An array of routing controls.
" + } + } + }, + "ListSafetyRulesRequest": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "location": "uri", + "locationName": "ControlPanelArn", + "documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting details for.
" + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "MaxResults", + "documentation": "The number of objects that you want to return with this call.
" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "NextToken", + "documentation": "The token that identifies which batch of results you want to see.
" + } + }, + "required": [ + "ControlPanelArn" + ] + }, + "ListSafetyRulesResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__stringMax8096", + "documentation": "The token that identifies which batch of results you want to see.
" + }, + "SafetyRules": { + "shape": "__listOfRule", + "documentation": "The list of safety rules in a control panel.
" + } + } + }, + "MaxResults": { + "type": "integer", + "min": 1, + "max": 1000 + }, + "NewAssertionRule": { + "type": "structure", + "members": { + "AssertedControls": { + "shape": "__listOf__string", + "documentation": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
" + }, + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) for the control panel.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the assertion rule. You can use any non-white space character in the name.
" + }, + "RuleConfig": { + "shape": "RuleConfig", + "documentation": "The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "A new assertion rule for a control panel.
", + "required": [ + "ControlPanelArn", + "AssertedControls", + "RuleConfig", + "WaitPeriodMs", + "Name" + ] + }, + "NewGatingRule": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel.
" + }, + "GatingControls": { + "shape": "__listOf__string", + "documentation": "The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name for the new gating rule.
" + }, + "RuleConfig": { + "shape": "RuleConfig", + "documentation": "The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
" + }, + "TargetControls": { + "shape": "__listOf__string", + "documentation": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
" + }, + "WaitPeriodMs": { + "shape": "__integer", + "documentation": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value.
" + } + }, + "documentation": "A new gating rule for a control panel.
", + "required": [ + "TargetControls", + "ControlPanelArn", + "GatingControls", + "RuleConfig", + "WaitPeriodMs", + "Name" + ] + }, + "ResourceNotFoundException": { + "type": "structure", + "documentation": "404 response - The query string contains a syntax error or resource not found.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 404 + } + }, + "RoutingControl": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
" + }, + "Name": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the routing control.
" + }, + "RoutingControlArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the routing control.
" + }, + "Status": { + "shape": "Status", + "documentation": "The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
" + } + }, + "documentation": "A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.
" + }, + "Rule": { + "type": "structure", + "members": { + "ASSERTION": { + "shape": "AssertionRule", + "documentation": "An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
" + }, + "GATING": { + "shape": "GatingRule", + "documentation": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
" + } + }, + "documentation": "A safety rule. A safety rule can be an assertion rule or a gating rule.
" + }, + "RuleConfig": { + "type": "structure", + "members": { + "Inverted": { + "shape": "__boolean", + "documentation": "Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
" + }, + "Threshold": { + "shape": "__integer", + "documentation": "The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
" + }, + "Type": { + "shape": "RuleType", + "documentation": "A rule can be one of the following: ATLEAST, AND, or OR.
" + } + }, + "documentation": "The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many controls must be enabled after a transaction completes.
", + "required": [ + "Type", + "Inverted", + "Threshold" + ] + }, + "RuleType": { + "type": "string", + "documentation": "An enumerated type that determines how the evaluated rules are processed. RuleType can be one of the following:
ATLEAST - At least N routing controls must be set. You specify N as the Threshold in the rule configuration.
AND - All routing controls must be set. This is a shortcut for \"At least N,\" where N is the total number of controls in the rule.
OR - Any control must be set. This is a shortcut for \"At least N,\" where N is 1.
", + "enum": [ + "ATLEAST", + "AND", + "OR" + ] + }, + "ServiceQuotaExceededException": { + "type": "structure", + "documentation": "402 response
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 402 + } + }, + "Status": { + "type": "string", + "documentation": "The deployment status of a resource. Status can be one of the following:
PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.
DEPLOYED: The resource is deployed and ready to use.
PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.
", + "enum": [ + "PENDING", + "DEPLOYED", + "PENDING_DELETION" + ] + }, + "ThrottlingException": { + "type": "structure", + "documentation": "429 response - ThrottlingException.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 429 + } + }, + "UpdateControlPanelRequest": { + "type": "structure", + "members": { + "ControlPanelArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the control panel.
" + }, + "ControlPanelName": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the control panel.
" + } + }, + "documentation": "The details of the control panel that you're updating.
", + "required": [ + "ControlPanelArn", + "ControlPanelName" + ] + }, + "UpdateControlPanelResponse": { + "type": "structure", + "members": { + "ControlPanel": { + "shape": "ControlPanel", + "documentation": "The control panel to update.
" + } + } + }, + "UpdateRoutingControlRequest": { + "type": "structure", + "members": { + "RoutingControlArn": { + "shape": "__string", + "documentation": "The Amazon Resource Name (ARN) of the routing control.
" + }, + "RoutingControlName": { + "shape": "__stringMin1Max64PatternS", + "documentation": "The name of the routing control.
" + } + }, + "documentation": "The details of the routing control that you're updating.
", + "required": [ + "RoutingControlName", + "RoutingControlArn" + ] + }, + "UpdateRoutingControlResponse": { + "type": "structure", + "members": { + "RoutingControl": { + "shape": "RoutingControl", + "documentation": "The routing control that was updated.
" + } + } + }, + "UpdateSafetyRuleRequest": { + "type": "structure", + "members": { + "AssertionRuleUpdate": { + "shape": "AssertionRuleUpdate" + }, + "GatingRuleUpdate": { + "shape": "GatingRuleUpdate" + } + } + }, + "UpdateSafetyRuleResponse": { + "type": "structure", + "members": { + "AssertionRule": { + "shape": "AssertionRule" + }, + "GatingRule": { + "shape": "GatingRule" + } + } + }, + "ValidationException": { + "type": "structure", + "documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 400 + } + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__listOfCluster": { + "type": "list", + "member": { + "shape": "Cluster" + } + }, + "__listOfClusterEndpoint": { + "type": "list", + "member": { + "shape": "ClusterEndpoint" + } + }, + "__listOfControlPanel": { + "type": "list", + "member": { + "shape": "ControlPanel" + } + }, + "__listOfRoutingControl": { + "type": "list", + "member": { + "shape": "RoutingControl" + } + }, + "__listOfRule": { + "type": "list", + "member": { + "shape": "Rule" + } + }, + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" + } + }, + "__long": { + "type": "long" + }, + "__string": { + "type": "string" + }, + "__stringMax64": { + "type": "string", + "max": 64 + }, + "__stringMax8096": { + "type": "string", + "max": 8096 + }, + "__stringMin1Max128": { + "type": "string", + "min": 1, + "max": 128 + }, + "__stringMin1Max32": { + "type": "string", + "min": 1, + "max": 32 + }, + "__stringMin1Max64PatternS": { + "type": "string", + "min": 1, + "max": 64, + "pattern": "^\\S+$" + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" + } + }, + "documentation": "Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
" +} diff --git a/services/route53recoverycontrolconfig/src/main/resources/codegen-resources/waiters-2.json b/services/route53recoverycontrolconfig/src/main/resources/codegen-resources/waiters-2.json new file mode 100644 index 000000000000..1794757e6d14 --- /dev/null +++ b/services/route53recoverycontrolconfig/src/main/resources/codegen-resources/waiters-2.json @@ -0,0 +1,152 @@ +{ + "version": 2, + "waiters": { + "ClusterCreated": { + "description": "Wait until a cluster is created", + "operation": "DescribeCluster", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status", + "expected": "DEPLOYED" + }, + { + "state": "retry", + "matcher": "path", + "argument": "Cluster.Status", + "expected": "PENDING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "ClusterDeleted": { + "description": "Wait for a cluster to be deleted", + "operation": "DescribeCluster", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 404 + }, + { + "state": "retry", + "matcher": "path", + "argument": "Cluster.Status", + "expected": "PENDING_DELETION" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "ControlPanelCreated": { + "description": "Wait until a control panel is created", + "operation": "DescribeControlPanel", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "ControlPanel.Status", + "expected": "DEPLOYED" + }, + { + "state": "retry", + "matcher": "path", + "argument": "ControlPanel.Status", + "expected": "PENDING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "ControlPanelDeleted": { + "description": "Wait until a control panel is deleted", + "operation": "DescribeControlPanel", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 404 + }, + { + "state": "retry", + "matcher": "path", + "argument": "ControlPanel.Status", + "expected": "PENDING_DELETION" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "RoutingControlCreated": { + "description": "Wait until a routing control is created", + "operation": "DescribeRoutingControl", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "RoutingControl.Status", + "expected": "DEPLOYED" + }, + { + "state": "retry", + "matcher": "path", + "argument": "RoutingControl.Status", + "expected": "PENDING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "RoutingControlDeleted": { + "description": "Wait for a routing control to be deleted", + "operation": "DescribeRoutingControl", + "delay": 5, + "maxAttempts": 26, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 404 + }, + { + "state": "retry", + "matcher": "path", + "argument": "RoutingControl.Status", + "expected": "PENDING_DELETION" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + } + } +} From a0a37d0a75200312cae5a5a287baa0149099c0be Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:08:01 +0000 Subject: [PATCH 11/14] Route53 Recovery Cluster Update: Amazon Route 53 Application Recovery Controller's routing control - Routing Control Data Plane APIs help you update the state (On/Off) of the routing controls to reroute traffic across application replicas in a 100% available manner. --- ...eature-Route53RecoveryCluster-5435d76.json | 6 + services/route53recoverycluster/pom.xml | 60 ++++ .../codegen-resources/paginators-1.json | 4 + .../codegen-resources/service-2.json | 308 ++++++++++++++++++ 4 files changed, 378 insertions(+) create mode 100644 .changes/next-release/feature-Route53RecoveryCluster-5435d76.json create mode 100644 services/route53recoverycluster/pom.xml create mode 100644 services/route53recoverycluster/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/route53recoverycluster/src/main/resources/codegen-resources/service-2.json diff --git a/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json b/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json new file mode 100644 index 000000000000..03703843dfce --- /dev/null +++ b/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Route53 Recovery Cluster", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Data Plane APIs help you update the state (On/Off) of the routing controls to reroute traffic across application replicas in a 100% available manner." +} diff --git a/services/route53recoverycluster/pom.xml b/services/route53recoverycluster/pom.xml new file mode 100644 index 000000000000..e5c3fabb1fcc --- /dev/null +++ b/services/route53recoverycluster/pom.xml @@ -0,0 +1,60 @@ + + + +Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
Before you can create a routing control, you first must create a cluster to host the control. For more information, see CreateCluster. Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
" + }, + "UpdateRoutingControlState":{ + "name":"UpdateRoutingControlState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRoutingControlStateRequest"}, + "output":{"shape":"UpdateRoutingControlStateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"EndpointTemporarilyUnavailableException"}, + {"shape":"ConflictException"} + ], + "documentation":"Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
" + }, + "UpdateRoutingControlStates":{ + "name":"UpdateRoutingControlStates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRoutingControlStatesRequest"}, + "output":{"shape":"UpdateRoutingControlStatesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"EndpointTemporarilyUnavailableException"}, + {"shape":"ConflictException"} + ], + "documentation":"Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You don't have sufficient permissions to query the routing control state.
", + "exception":true + }, + "Arn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[A-Za-z0-9:\\/_-]*$" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"Description of the ConflictException error" + }, + "resourceId":{ + "shape":"String", + "documentation":"Identifier of the resource in use" + }, + "resourceType":{ + "shape":"String", + "documentation":"Type of the resource in use" + } + }, + "documentation":"There was a conflict with this request. Try again.
", + "exception":true + }, + "EndpointTemporarilyUnavailableException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The cluster endpoint isn't available. Try another cluster endpoint.
", + "exception":true + }, + "GetRoutingControlStateRequest":{ + "type":"structure", + "required":["RoutingControlArn"], + "members":{ + "RoutingControlArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Number (ARN) for the routing control that you want to get the state for.
" + } + } + }, + "GetRoutingControlStateResponse":{ + "type":"structure", + "required":[ + "RoutingControlArn", + "RoutingControlState" + ], + "members":{ + "RoutingControlArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Number (ARN) of the response.
" + }, + "RoutingControlState":{ + "shape":"RoutingControlState", + "documentation":"The state of the routing control.
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{"shape":"RetryAfterSeconds"} + }, + "documentation":"There was an unexpected error during processing of the request.
", + "exception":true, + "fault":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"String"}, + "resourceId":{ + "shape":"String", + "documentation":"Hypothetical resource identifier that was not found" + }, + "resourceType":{ + "shape":"String", + "documentation":"Hypothetical resource type that was not found" + } + }, + "documentation":"The request references a routing control that was not found.
", + "exception":true + }, + "RetryAfterSeconds":{ + "type":"integer", + "documentation":"Advice to clients on when the call can be safely retried" + }, + "RoutingControlState":{ + "type":"string", + "enum":[ + "On", + "Off" + ] + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "retryAfterSeconds":{"shape":"RetryAfterSeconds"} + }, + "documentation":"The request was denied because of request throttling.
", + "exception":true + }, + "UpdateRoutingControlStateEntries":{ + "type":"list", + "member":{"shape":"UpdateRoutingControlStateEntry"} + }, + "UpdateRoutingControlStateEntry":{ + "type":"structure", + "required":[ + "RoutingControlArn", + "RoutingControlState" + ], + "members":{ + "RoutingControlArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Number (ARN) for the routing control state entry.
" + }, + "RoutingControlState":{ + "shape":"RoutingControlState", + "documentation":"The routing control state in a set of routing control state entries.
" + } + }, + "documentation":"A routing control state.
" + }, + "UpdateRoutingControlStateRequest":{ + "type":"structure", + "required":[ + "RoutingControlArn", + "RoutingControlState" + ], + "members":{ + "RoutingControlArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Number (ARN) for the routing control that you want to update the state for.
" + }, + "RoutingControlState":{ + "shape":"RoutingControlState", + "documentation":"The state of the routing control. You can set the value to be On or Off.
" + } + } + }, + "UpdateRoutingControlStateResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRoutingControlStatesRequest":{ + "type":"structure", + "required":["UpdateRoutingControlStateEntries"], + "members":{ + "UpdateRoutingControlStateEntries":{ + "shape":"UpdateRoutingControlStateEntries", + "documentation":"A set of routing control entries that you want to update.
" + } + } + }, + "UpdateRoutingControlStatesResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"}, + "reason":{"shape":"ValidationExceptionReason"}, + "fields":{"shape":"ValidationExceptionFieldList"} + }, + "documentation":"There was a validation error on the request.
", + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "name", + "message" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"The field that had the validation exception.
" + }, + "message":{ + "shape":"String", + "documentation":"Information about the validation exception.
" + } + }, + "documentation":"There was a validation error on the request.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"}, + "documentation":"The fields that caused the error, if applicable" + }, + "ValidationExceptionReason":{ + "type":"string", + "documentation":"Reason the request failed validation", + "enum":[ + "unknownOperation", + "cannotParse", + "fieldValidationFailed", + "other" + ] + } + }, + "documentation":"Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .
Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or get the state of routing controls. You use routing controls to failover traffic to recover your application across Availability Zones or Regions.
This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.
For more information about Route 53 Application Recovery Controller, see the following:
You can create clusters, routing controls, and control panels by using the control plane API for Recovery Control. For more information, see Amazon Route 53 Application Recovery Controller Recovery Control API Reference.
Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic. For more information about the related API actions, see Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference.
For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
" + "documentation":"Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
" }, "CreateDataset":{ "name":"CreateDataset", @@ -82,7 +82,7 @@ {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"} ], - "documentation":"Creates a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.
Used to create a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.
Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
Creates a data store, which is a repository for messages. Only data stores that are used to save pipeline data can be configured with ParquetConfiguration.
Creates a data store, which is a repository for messages.
" }, "CreatePipeline":{ "name":"CreatePipeline", @@ -290,7 +290,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Retrieves the current settings of the AWS IoT Analytics logging options.
" + "documentation":"Retrieves the current settings of the IoT Analytics logging options.
" }, "DescribePipeline":{ "name":"DescribePipeline", @@ -324,7 +324,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Retrieves the contents of a data set as presigned URIs.
" + "documentation":"Retrieves the contents of a dataset as presigned URIs.
" }, "ListChannels":{ "name":"ListChannels", @@ -357,7 +357,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists information about data set contents that have been created.
" + "documentation":"Lists information about dataset contents that have been created.
" }, "ListDatasets":{ "name":"ListDatasets", @@ -373,7 +373,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Retrieves information about data sets.
" + "documentation":"Retrieves information about datasets.
" }, "ListDatastores":{ "name":"ListDatastores", @@ -438,7 +438,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Sets or updates the AWS IoT Analytics logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
Sets or updates the IoT Analytics logging options.
If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
Updates the settings of a channel.
" + "documentation":"Used to update the settings of a channel.
" }, "UpdateDataset":{ "name":"UpdateDataset", @@ -559,7 +559,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Updates the settings of a data set.
" + "documentation":"Updates the settings of a dataset.
" }, "UpdateDatastore":{ "name":"UpdateDatastore", @@ -575,7 +575,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ThrottlingException"} ], - "documentation":"Updates the settings of a data store.
" + "documentation":"Used to update the settings of a data store.
" }, "UpdatePipeline":{ "name":"UpdatePipeline", @@ -681,7 +681,7 @@ }, "messages":{ "shape":"Messages", - "documentation":"The list of messages to be sent. Each message has the format: { \"messageId\": \"string\", \"payload\": \"string\"}.
The field names of message payloads (data) that you send to AWS IoT Analytics:
Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".
Cannot be more than 255 characters.
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.
" + "documentation":"The list of messages to be sent. Each message has the format: { \"messageId\": \"string\", \"payload\": \"string\"}.
The field names of message payloads (data) that you send to IoT Analytics:
Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".
Cannot be more than 255 characters.
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.
" } } }, @@ -741,7 +741,7 @@ }, "storage":{ "shape":"ChannelStorage", - "documentation":"Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the channel is created.
Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
The last time when a new message arrived in the channel.
AWS IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" + "documentation":"The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" } }, "documentation":"A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
" @@ -807,7 +807,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9_]+$" + "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)" }, "ChannelStatistics":{ "type":"structure", @@ -832,21 +832,21 @@ "members":{ "serviceManagedS3":{ "shape":"ServiceManagedChannelS3Storage", - "documentation":"Use this to store channel data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.
" + "documentation":"Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
" }, "customerManagedS3":{ "shape":"CustomerManagedChannelS3Storage", - "documentation":"Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.
Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
Where channel data is stored. You may choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. This cannot be changed after creation of the channel.
Where channel data is stored. You may choose one of serviceManagedS3, customerManagedS3 storage. If not specified, the default is serviceManagedS3. This can't be changed after creation of the channel.
Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
" + "documentation":"Used to store channel data in an S3 bucket managed by IoT Analytics.
" }, "customerManagedS3":{ "shape":"CustomerManagedChannelS3StorageSummary", @@ -884,7 +884,7 @@ }, "lastMessageArrivalTime":{ "shape":"Timestamp", - "documentation":"The last time when a new message arrived in the channel.
AWS IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" + "documentation":"The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" } }, "documentation":"A summary of information about a channel.
" @@ -902,7 +902,7 @@ }, "type":{ "shape":"ColumnDataType", - "documentation":"The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide.
" + "documentation":"The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.
" } }, "documentation":"Contains information about a column that stores your data.
" @@ -967,7 +967,7 @@ }, "channelStorage":{ "shape":"ChannelStorage", - "documentation":"Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the channel is created.
Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
The name of the data set.
" + "documentation":"The name of the dataset.
" }, "actions":{ "shape":"DatasetActions", - "documentation":"A list of actions that create the data set contents.
" + "documentation":"A list of actions that create the dataset contents.
" }, "triggers":{ "shape":"DatasetTriggers", - "documentation":"A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
A list of triggers. A trigger causes dataset contents to be populated at a specified time interval or when another dataset's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.
Optional. How long, in days, versions of dataset contents are kept for the dataset. If not specified or set to null, versions of dataset contents are retained for at most 90 days. The number of versions of dataset contents retained is determined by the versioningConfiguration parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
Metadata which can be used to manage the data set.
" + "documentation":"Metadata which can be used to manage the dataset.
" }, "lateDataRules":{ "shape":"LateDataRules", - "documentation":"A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
Where data store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the data store is created.
Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" + "documentation":"Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" }, "datastorePartitions":{ "shape":"DatastorePartitions", - "documentation":"Contains information about the partitions in a data store.
" + "documentation":"Contains information about the partition dimensions in a data store.
" } } }, @@ -1139,7 +1139,7 @@ }, "pipelineActivities":{ "shape":"PipelineActivities", - "documentation":"A list of PipelineActivity objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]
A list of PipelineActivity objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda unctions on messages for advanced processing; or performing mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]
Optional. The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" + "documentation":"(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
" } }, - "documentation":"Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.
Used to store channel data in an S3 bucket that you manage. If customer-managed storage is selected, the retentionPeriod parameter is ignored. You can't change the choice of S3 storage after the data store is created.
Optional. The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
" + "documentation":"(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
" } }, "documentation":"Used to store channel data in an S3 bucket that you manage.
" @@ -1209,55 +1209,55 @@ "members":{ "bucket":{ "shape":"BucketName", - "documentation":"The name of the S3 bucket in which data store data is stored.
" + "documentation":"The name of the Amazon S3 bucket where your data is stored.
" }, "keyPrefix":{ "shape":"S3KeyPrefix", - "documentation":"Optional. The prefix used to create the keys of the data store data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" + "documentation":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
" } }, - "documentation":"Use this to store data store data in an S3 bucket that you manage. When customer-managed storage is selected, the retentionPeriod parameter is ignored. You cannot change the choice of service-managed or customer-managed S3 storage after the data store is created.
S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
The name of the S3 bucket in which data store data is stored.
" + "documentation":"The name of the Amazon S3 bucket where your data is stored.
" }, "keyPrefix":{ "shape":"S3KeyPrefix", - "documentation":"Optional. The prefix used to create the keys of the data store data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" + "documentation":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
" } }, - "documentation":"Used to store data store data in an S3 bucket that you manage.
" + "documentation":"Contains information about the data store that you manage.
" }, "Dataset":{ "type":"structure", "members":{ "name":{ "shape":"DatasetName", - "documentation":"The name of the data set.
" + "documentation":"The name of the dataset.
" }, "arn":{ "shape":"DatasetArn", - "documentation":"The ARN of the data set.
" + "documentation":"The ARN of the dataset.
" }, "actions":{ "shape":"DatasetActions", - "documentation":"The DatasetAction objects that automatically create the data set contents.
The DatasetAction objects that automatically create the dataset contents.
The DatasetTrigger objects that specify when the data set is automatically updated.
The DatasetTrigger objects that specify when the dataset is automatically updated.
The status of the data set.
" + "documentation":"The status of the dataset.
" }, "creationTime":{ "shape":"Timestamp", - "documentation":"When the data set was created.
" + "documentation":"When the dataset was created.
" }, "lastUpdateTime":{ "shape":"Timestamp", - "documentation":"The last time the data set was updated.
" + "documentation":"The last time the dataset was updated.
" }, "retentionPeriod":{ "shape":"RetentionPeriod", - "documentation":"Optional. How long, in days, message data is kept for the data set.
" + "documentation":"Optional. How long, in days, message data is kept for the dataset.
" }, "versioningConfiguration":{ "shape":"VersioningConfiguration", - "documentation":"Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
Information about a data set.
" + "documentation":"Information about a dataset.
" }, "DatasetAction":{ "type":"structure", "members":{ "actionName":{ "shape":"DatasetActionName", - "documentation":"The name of the data set action by which data set contents are automatically created.
" + "documentation":"The name of the dataset action by which dataset contents are automatically created.
" }, "queryAction":{ "shape":"SqlQueryDatasetAction", - "documentation":"An SqlQueryDatasetAction object that uses an SQL query to automatically create data set contents.
An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
Information that allows the system to run a containerized application to create the dataset contents. The application must be in a Docker container along with any required support libraries.
" } }, - "documentation":"A DatasetAction object that specifies how data set contents are automatically created.
A DatasetAction object that specifies how dataset contents are automatically created.
Configuration information for delivery of dataset contents to AWS IoT Events.
" + "documentation":"Configuration information for delivery of dataset contents to IoT Events.
" }, "s3DestinationConfiguration":{ "shape":"S3DestinationConfiguration", @@ -1396,14 +1396,14 @@ "members":{ "state":{ "shape":"DatasetContentState", - "documentation":"The state of the data set contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
" + "documentation":"The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
" }, "reason":{ "shape":"Reason", - "documentation":"The reason the data set contents are in this state.
" + "documentation":"The reason the dataset contents are in this state.
" } }, - "documentation":"The state of the data set contents and the reason they are in this state.
" + "documentation":"The state of the dataset contents and the reason they are in this state.
" }, "DatasetContentSummaries":{ "type":"list", @@ -1418,7 +1418,7 @@ }, "status":{ "shape":"DatasetContentStatus", - "documentation":"The status of the data set contents.
" + "documentation":"The status of the dataset contents.
" }, "creationTime":{ "shape":"Timestamp", @@ -1460,20 +1460,20 @@ "members":{ "entryName":{ "shape":"EntryName", - "documentation":"The name of the data set item.
" + "documentation":"The name of the dataset item.
" }, "dataURI":{ "shape":"PresignedURI", - "documentation":"The presigned URI of the data set item.
" + "documentation":"The presigned URI of the dataset item.
" } }, - "documentation":"The reference to a data set entry.
" + "documentation":"The reference to a dataset entry.
" }, "DatasetName":{ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9_]+$" + "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)" }, "DatasetStatus":{ "type":"string", @@ -1492,30 +1492,30 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set.
" + "documentation":"The name of the dataset.
" }, "status":{ "shape":"DatasetStatus", - "documentation":"The status of the data set.
" + "documentation":"The status of the dataset.
" }, "creationTime":{ "shape":"Timestamp", - "documentation":"The time the data set was created.
" + "documentation":"The time the dataset was created.
" }, "lastUpdateTime":{ "shape":"Timestamp", - "documentation":"The last time the data set was updated.
" + "documentation":"The last time the dataset was updated.
" }, "triggers":{ "shape":"DatasetTriggers", - "documentation":"A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
A list of DataActionSummary objects.
A summary of information about a data set.
" + "documentation":"A summary of information about a dataset.
" }, "DatasetTrigger":{ "type":"structure", @@ -1526,10 +1526,10 @@ }, "dataset":{ "shape":"TriggeringDataset", - "documentation":"The data set whose content creation triggers the creation of this data set's contents.
" + "documentation":"The dataset whose content creation triggers the creation of this dataset's contents.
" } }, - "documentation":"The DatasetTrigger that specifies when the data set is automatically updated.
The DatasetTrigger that specifies when the dataset is automatically updated.
Where data store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the data store is created.
Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
The last time when a new message arrived in the data store.
AWS IoT Analytics updates this value at most once per minute for one data store. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" + "documentation":"The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" }, "fileFormatConfiguration":{ "shape":"FileFormatConfiguration", - "documentation":"Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" + "documentation":"Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" }, "datastorePartitions":{ "shape":"DatastorePartitions", - "documentation":"Contains information about the partitions in a data store.
" + "documentation":"Contains information about the partition dimensions in a data store.
" } }, "documentation":"Information about a data store.
" @@ -1602,35 +1602,56 @@ "documentation":"The datastore activity that specifies where to store the processed data.
" }, "DatastoreArn":{"type":"string"}, + "DatastoreIotSiteWiseMultiLayerStorage":{ + "type":"structure", + "required":["customerManagedS3Storage"], + "members":{ + "customerManagedS3Storage":{ + "shape":"IotSiteWiseCustomerManagedDatastoreS3Storage", + "documentation":"Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
" + } + }, + "documentation":"Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
" + }, + "DatastoreIotSiteWiseMultiLayerStorageSummary":{ + "type":"structure", + "members":{ + "customerManagedS3Storage":{ + "shape":"IotSiteWiseCustomerManagedDatastoreS3StorageSummary", + "documentation":"Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
" + } + }, + "documentation":"Contains information about the data store that you manage, which stores data used by IoT SiteWise.
" + }, "DatastoreName":{ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9_]+$" + "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)" }, "DatastorePartition":{ "type":"structure", "members":{ "attributePartition":{ "shape":"Partition", - "documentation":" A partition defined by an attributeName.
A partition dimension defined by an attributeName.
A partition defined by an attributeName and a timestamp format.
A partition dimension defined by a timestamp attribute.
" } }, - "documentation":"A single partition in a data store.
" + "documentation":" A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.
A list of partitions in a data store.
" + "documentation":"A list of partition dimensions in a data store.
" } }, - "documentation":"Contains information about partitions in a data store.
" + "documentation":"Contains information about the partition dimensions in a data store.
" }, "DatastoreStatistics":{ "type":"structure", @@ -1655,28 +1676,36 @@ "members":{ "serviceManagedS3":{ "shape":"ServiceManagedDatastoreS3Storage", - "documentation":"Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the data store is created.
" + "documentation":"Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
" }, "customerManagedS3":{ "shape":"CustomerManagedDatastoreS3Storage", - "documentation":"Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the retentionPeriod parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
" } }, - "documentation":"Where data store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the data store is created.
Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
" + "documentation":"Used to store data in an Amazon S3 bucket managed by IoT Analytics.
" }, "customerManagedS3":{ "shape":"CustomerManagedDatastoreS3StorageSummary", - "documentation":"Used to store data store data in an S3 bucket that you manage.
" + "documentation":"Used to store data in an Amazon S3 bucket managed by IoT Analytics.
" + }, + "iotSiteWiseMultiLayerStorage":{ + "shape":"DatastoreIotSiteWiseMultiLayerStorageSummary", + "documentation":"Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
" } }, - "documentation":"Where data store data is stored.
" + "documentation":"Contains information about your data store.
" }, "DatastoreSummaries":{ "type":"list", @@ -1691,7 +1720,7 @@ }, "datastoreStorage":{ "shape":"DatastoreStorageSummary", - "documentation":"Where data store data is stored.
" + "documentation":"Where data in a data store is stored.
" }, "status":{ "shape":"DatastoreStatus", @@ -1707,7 +1736,7 @@ }, "lastMessageArrivalTime":{ "shape":"Timestamp", - "documentation":"The last time when a new message arrived in the data store.
AWS IoT Analytics updates this value at most once per minute for one data store. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" + "documentation":"The last time when a new message arrived in the data store.
IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" }, "fileFormatType":{ "shape":"FileFormatType", @@ -1715,7 +1744,7 @@ }, "datastorePartitions":{ "shape":"DatastorePartitions", - "documentation":"Contains information about the partitions in a data store.
" + "documentation":"Contains information about the partition dimensions in a data store.
" } }, "documentation":"A summary of information about a data store.
" @@ -1756,7 +1785,7 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set to delete.
", + "documentation":"The name of the dataset to delete.
", "location":"uri", "locationName":"datasetName" } @@ -1810,10 +1839,10 @@ "members":{ "timeoutInMinutes":{ "shape":"SessionTimeoutInMinutes", - "documentation":"A time interval. You can use timeoutInMinutes so that AWS IoT Analytics can batch up late data notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.
For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
" + "documentation":"A time interval. You can use timeoutInMinutes so that IoT Analytics can batch up late data notifications that have been generated since the last execution. IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.
For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.
" } }, - "documentation":"A structure that contains the configuration information of a delta time session window.
DeltaTime specifies a time interval. You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. For an example of DeltaTime, see Creating a SQL dataset with a delta window (CLI) in the AWS IoT Analytics User Guide.
A structure that contains the configuration information of a delta time session window.
DeltaTime specifies a time interval. You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. For an example of DeltaTime, see Creating a SQL dataset with a delta window (CLI) in the IoT Analytics User Guide.
If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.
", + "documentation":"If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.
", "location":"querystring", "locationName":"includeStatistics" } @@ -1852,7 +1881,7 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set whose information is retrieved.
", + "documentation":"The name of the dataset whose information is retrieved.
", "location":"uri", "locationName":"datasetName" } @@ -1863,7 +1892,7 @@ "members":{ "dataset":{ "shape":"Dataset", - "documentation":"An object that contains information about the data set.
" + "documentation":"An object that contains information about the dataset.
" } } }, @@ -1879,7 +1908,7 @@ }, "includeStatistics":{ "shape":"IncludeStatisticsFlag", - "documentation":"If true, additional statistical information about the data store is included in the response. This feature cannot be used with a data store whose S3 storage is customer-managed.
", + "documentation":"If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.
", "location":"querystring", "locationName":"includeStatistics" } @@ -1908,7 +1937,7 @@ "members":{ "loggingOptions":{ "shape":"LoggingOptions", - "documentation":"The current settings of the AWS IoT Analytics logging options.
" + "documentation":"The current settings of the IoT Analytics logging options.
" } } }, @@ -1963,7 +1992,7 @@ "documentation":"The next activity in the pipeline.
" } }, - "documentation":"An activity that adds data from the AWS IoT device registry to your message.
" + "documentation":"An activity that adds data from the IoT device registry to your message.
" }, "DeviceShadowEnrichActivity":{ "type":"structure", @@ -1995,7 +2024,7 @@ "documentation":"The next activity in the pipeline.
" } }, - "documentation":"An activity that adds information from the AWS IoT Device Shadow service to a message.
" + "documentation":"An activity that adds information from the IoT Device Shadow service to a message.
" }, "DoubleValue":{"type":"double"}, "EndTime":{"type":"timestamp"}, @@ -2028,7 +2057,7 @@ "documentation":"Contains the configuration information of the Parquet format.
" } }, - "documentation":"Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" + "documentation":"Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" }, "FileFormatType":{ "type":"string", @@ -2070,13 +2099,13 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set whose contents are retrieved.
", + "documentation":"The name of the dataset whose contents are retrieved.
", "location":"uri", "locationName":"datasetName" }, "versionId":{ "shape":"DatasetContentVersion", - "documentation":"The version of the data set whose contents are retrieved. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.
", + "documentation":"The version of the dataset whose contents are retrieved. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the latest or latest successfully completed dataset. If not specified, \"$LATEST_SUCCEEDED\" is the default.
", "location":"querystring", "locationName":"versionId" } @@ -2095,7 +2124,7 @@ }, "status":{ "shape":"DatasetContentStatus", - "documentation":"The status of the data set content.
" + "documentation":"The status of the dataset content.
" } } }, @@ -2108,14 +2137,14 @@ "members":{ "tableName":{ "shape":"GlueTableName", - "documentation":"The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
" + "documentation":"The name of the table in your Glue Data Catalog that is used to perform the ETL operations. An Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
" }, "databaseName":{ "shape":"GlueDatabaseName", - "documentation":"The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains metadata tables.
" + "documentation":"The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.
" } }, - "documentation":"Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.
" + "documentation":"Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
" }, "GlueDatabaseName":{ "type":"string", @@ -2162,14 +2191,14 @@ "members":{ "inputName":{ "shape":"IotEventsInputName", - "documentation":"The name of the AWS IoT Events input to which dataset contents are delivered.
" + "documentation":"The name of the IoT Events input to which dataset contents are delivered.
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to deliver dataset contents to an IoT Events input.
" } }, - "documentation":"Configuration information for delivery of dataset contents to AWS IoT Events.
" + "documentation":"Configuration information for delivery of dataset contents to IoT Events.
" }, "IotEventsInputName":{ "type":"string", @@ -2177,6 +2206,35 @@ "min":1, "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" }, + "IotSiteWiseCustomerManagedDatastoreS3Storage":{ + "type":"structure", + "required":["bucket"], + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"The name of the Amazon S3 bucket where your data is stored.
" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" + } + }, + "documentation":"Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
" + }, + "IotSiteWiseCustomerManagedDatastoreS3StorageSummary":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"The name of the Amazon S3 bucket where your data is stored.
" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
" + } + }, + "documentation":"Contains information about the data store that you manage, which stores data used by IoT SiteWise.
" + }, "JsonConfiguration":{ "type":"structure", "members":{ @@ -2298,7 +2356,7 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set whose contents information you want to list.
", + "documentation":"The name of the dataset whose contents information you want to list.
", "location":"uri", "locationName":"datasetName" }, @@ -2316,13 +2374,13 @@ }, "scheduledOnOrAfter":{ "shape":"Timestamp", - "documentation":"A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
Summary information about data set contents that have been created.
" + "documentation":"Summary information about dataset contents that have been created.
" }, "nextToken":{ "shape":"NextToken", @@ -2468,7 +2526,7 @@ "members":{ "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
" + "documentation":"The ARN of the role that grants permission to IoT Analytics to perform logging.
" }, "level":{ "shape":"LoggingLevel", @@ -2476,7 +2534,7 @@ }, "enabled":{ "shape":"LoggingEnabled", - "documentation":"If true, logging is enabled for AWS IoT Analytics.
" + "documentation":"If true, logging is enabled for IoT Analytics.
" } }, "documentation":"Information about logging options.
" @@ -2596,10 +2654,10 @@ "members":{ "attributeName":{ "shape":"PartitionAttributeName", - "documentation":"The attribute name of the partition.
" + "documentation":"The name of the attribute that defines a partition dimension.
" } }, - "documentation":"A single partition.
" + "documentation":"A partition dimension defined by an attribute.
" }, "PartitionAttributeName":{ "type":"string", @@ -2674,7 +2732,7 @@ }, "selectAttributes":{ "shape":"SelectAttributesActivity", - "documentation":"Creates a new message using only the specified attributes from the original message.
" + "documentation":"Used to create a new message using only the specified attributes from the original message.
" }, "filter":{ "shape":"FilterActivity", @@ -2686,11 +2744,11 @@ }, "deviceRegistryEnrich":{ "shape":"DeviceRegistryEnrichActivity", - "documentation":"Adds data from the AWS IoT device registry to your message.
" + "documentation":"Adds data from the IoT device registry to your message.
" }, "deviceShadowEnrich":{ "shape":"DeviceShadowEnrichActivity", - "documentation":"Adds information from the AWS IoT Device Shadow service to a message.
" + "documentation":"Adds information from the IoT Device Shadow service to a message.
" } }, "documentation":"An activity that performs a transformation on a message.
" @@ -2700,7 +2758,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9_]+$" + "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)" }, "PipelineSummaries":{ "type":"list", @@ -2735,7 +2793,7 @@ "members":{ "loggingOptions":{ "shape":"LoggingOptions", - "documentation":"The new values of the AWS IoT Analytics logging options.
" + "documentation":"The new values of the IoT Analytics logging options.
" } } }, @@ -2891,7 +2949,7 @@ "members":{ "pipelineActivity":{ "shape":"PipelineActivity", - "documentation":"The pipeline activity that is run. This must not be a channel activity or a datastore activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a lambda activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
" + "documentation":"The pipeline activity that is run. This must not be a channel activity or a data store activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a Lambda activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
" }, "payloads":{ "shape":"MessagePayloads", @@ -2930,11 +2988,11 @@ }, "glueConfiguration":{ "shape":"GlueConfiguration", - "documentation":"Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.
" + "documentation":"Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
" }, "roleArn":{ "shape":"RoleArn", - "documentation":"The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
" + "documentation":"The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
" } }, "documentation":"Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
" @@ -3037,31 +3095,31 @@ "documentation":"The next activity in the pipeline.
" } }, - "documentation":"Creates a new message using only the specified attributes from the original message.
" + "documentation":"Used to create a new message using only the specified attributes from the original message.
" }, "ServiceManagedChannelS3Storage":{ "type":"structure", "members":{ }, - "documentation":"Use this to store channel data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the channel is created.
" + "documentation":"Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
" }, "ServiceManagedChannelS3StorageSummary":{ "type":"structure", "members":{ }, - "documentation":"Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
" + "documentation":"Used to store channel data in an S3 bucket managed by IoT Analytics.
" }, "ServiceManagedDatastoreS3Storage":{ "type":"structure", "members":{ }, - "documentation":"Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You cannot change the choice of service-managed or customer-managed S3 storage after the data store is created.
" + "documentation":"Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.
" }, "ServiceManagedDatastoreS3StorageSummary":{ "type":"structure", "members":{ }, - "documentation":"Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
" + "documentation":"Contains information about the data store that is managed by IoT Analytics.
" }, "ServiceUnavailableException":{ "type":"structure", @@ -3225,10 +3283,10 @@ }, "timestampFormat":{ "shape":"TimestampFormat", - "documentation":"The timestamp format of a partition defined by a timestamp.
" + "documentation":"The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
" } }, - "documentation":"A partition defined by a timestamp.
" + "documentation":"A partition dimension defined by a timestamp attribute.
" }, "TriggeringDataset":{ "type":"structure", @@ -3281,11 +3339,11 @@ }, "channelStorage":{ "shape":"ChannelStorage", - "documentation":"Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the channel is created.
Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.
How long, in days, message data is kept for the channel. The retention period cannot be updated if the channel's S3 storage is customer-managed.
" + "documentation":"How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
" } } }, @@ -3298,7 +3356,7 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set to update.
", + "documentation":"The name of the dataset to update.
", "location":"uri", "locationName":"datasetName" }, @@ -3320,11 +3378,11 @@ }, "versioningConfiguration":{ "shape":"VersioningConfiguration", - "documentation":"Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT Analytics User Guide.
Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.
A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
How long, in days, message data is kept for the data store. The retention period cannot be updated if the data store's S3 storage is customer-managed.
" + "documentation":"How long, in days, message data is kept for the data store. The retention period can't be updated if the data store's Amazon S3 storage is customer-managed.
" }, "datastoreStorage":{ "shape":"DatastoreStorage", - "documentation":"Where data store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default isserviceManagedS3. You cannot change this storage option after the data store is created.
Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" + "documentation":"Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.
The default file format is JSON. You can specify only one format.
You can't change the file format after you create the data store.
" } } }, @@ -3433,5 +3491,5 @@ "resourceArn":{"type":"string"}, "resourceId":{"type":"string"} }, - "documentation":"AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.
Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.
AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.
" + "documentation":"IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.
Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.
IoT Analytics automates the steps required to analyze data from IoT devices. IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.
" } From 84895158b35259baf83d81edc5b77771b326071f Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:09:29 +0000 Subject: [PATCH 13/14] Updated endpoints.json. --- .../feature-AWSSDKforJavav2-bedacd4.json | 6 +++ .../regions/internal/region/endpoints.json | 42 +++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 .changes/next-release/feature-AWSSDKforJavav2-bedacd4.json diff --git a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json new file mode 100644 index 000000000000..ae3f84993e9e --- /dev/null +++ b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS SDK for Java v2", + "contributor": "", + "description": "Updated service endpoint metadata." +} diff --git a/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json b/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json index 487da328ed4c..b04bea45eddd 100644 --- a/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json +++ b/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json @@ -1251,6 +1251,7 @@ "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2752,6 +2753,36 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "emr-containers-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "emr-containers-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "emr-containers-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "emr-containers-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "emr-containers-fips.us-west-2.amazonaws.com" + }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -7850,6 +7881,12 @@ }, "neptune" : { "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "rds.cn-north-1.amazonaws.com.cn" + }, "cn-northwest-1" : { "credentialScope" : { "region" : "cn-northwest-1" @@ -10457,6 +10494,11 @@ "us-isob-east-1" : { } } }, + "ds" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "dynamodb" : { "defaults" : { "protocols" : [ "http", "https" ] From a3b67086f6cc4ddab7967b8974042502fd89a7aa Mon Sep 17 00:00:00 2001 From: AWS <> Date: Tue, 27 Jul 2021 18:10:17 +0000 Subject: [PATCH 14/14] Release 2.17.6. Updated CHANGELOG.md, README.md and all pom.xml. --- .changes/2.17.6.json | 78 +++++++++++++++++++ .../feature-AWSBatch-e691b83.json | 6 -- .../feature-AWSIoTAnalytics-738678e.json | 6 -- .../feature-AWSIoTWireless-0048165.json | 6 -- ...SRoute53RecoveryControlConfig-a53438f.json | 6 -- ...e-AWSRoute53RecoveryReadiness-3dba109.json | 6 -- .../feature-AWSSDKforJavav2-bedacd4.json | 6 -- .../feature-AWSShield-67ae7d6.json | 6 -- ...ture-AmazonLexModelBuildingV2-77f6e9c.json | 6 -- .../feature-AmazonQuickSight-5e5ea2b.json | 6 -- .../feature-AmazonRoute53-fb8b7d7.json | 6 -- ...eature-RedshiftDataAPIService-c4e58cd.json | 6 -- ...eature-Route53RecoveryCluster-5435d76.json | 6 -- CHANGELOG.md | 49 ++++++++++++ README.md | 8 +- archetypes/archetype-app-quickstart/pom.xml | 2 +- archetypes/archetype-lambda/pom.xml | 2 +- archetypes/archetype-tools/pom.xml | 2 +- archetypes/pom.xml | 2 +- aws-sdk-java/pom.xml | 17 +++- bom-internal/pom.xml | 2 +- bom/pom.xml | 17 +++- bundle/pom.xml | 2 +- codegen-lite-maven-plugin/pom.xml | 2 +- codegen-lite/pom.xml | 2 +- codegen-maven-plugin/pom.xml | 2 +- codegen/pom.xml | 2 +- core/annotations/pom.xml | 2 +- core/arns/pom.xml | 2 +- core/auth/pom.xml | 2 +- core/aws-core/pom.xml | 2 +- core/json-utils/pom.xml | 2 +- core/metrics-spi/pom.xml | 2 +- core/pom.xml | 2 +- core/profiles/pom.xml | 2 +- core/protocols/aws-cbor-protocol/pom.xml | 2 +- core/protocols/aws-json-protocol/pom.xml | 2 +- core/protocols/aws-query-protocol/pom.xml | 2 +- core/protocols/aws-xml-protocol/pom.xml | 2 +- core/protocols/pom.xml | 2 +- core/protocols/protocol-core/pom.xml | 2 +- core/regions/pom.xml | 2 +- core/sdk-core/pom.xml | 2 +- http-client-spi/pom.xml | 2 +- http-clients/apache-client/pom.xml | 2 +- http-clients/aws-crt-client/pom.xml | 2 +- http-clients/netty-nio-client/pom.xml | 2 +- http-clients/pom.xml | 2 +- http-clients/url-connection-client/pom.xml | 2 +- .../cloudwatch-metric-publisher/pom.xml | 2 +- metric-publishers/pom.xml | 2 +- pom.xml | 2 +- release-scripts/pom.xml | 2 +- services-custom/dynamodb-enhanced/pom.xml | 2 +- services-custom/pom.xml | 2 +- services/accessanalyzer/pom.xml | 2 +- services/acm/pom.xml | 2 +- services/acmpca/pom.xml | 2 +- services/alexaforbusiness/pom.xml | 2 +- services/amp/pom.xml | 2 +- services/amplify/pom.xml | 2 +- services/amplifybackend/pom.xml | 2 +- services/apigateway/pom.xml | 2 +- services/apigatewaymanagementapi/pom.xml | 2 +- services/apigatewayv2/pom.xml | 2 +- services/appconfig/pom.xml | 2 +- services/appflow/pom.xml | 2 +- services/appintegrations/pom.xml | 2 +- services/applicationautoscaling/pom.xml | 2 +- services/applicationcostprofiler/pom.xml | 2 +- services/applicationdiscovery/pom.xml | 2 +- services/applicationinsights/pom.xml | 2 +- services/appmesh/pom.xml | 2 +- services/apprunner/pom.xml | 2 +- services/appstream/pom.xml | 2 +- services/appsync/pom.xml | 2 +- services/athena/pom.xml | 2 +- services/auditmanager/pom.xml | 2 +- services/autoscaling/pom.xml | 2 +- services/autoscalingplans/pom.xml | 2 +- services/backup/pom.xml | 2 +- services/batch/pom.xml | 2 +- services/braket/pom.xml | 2 +- services/budgets/pom.xml | 2 +- services/chime/pom.xml | 2 +- services/cloud9/pom.xml | 2 +- services/clouddirectory/pom.xml | 2 +- services/cloudformation/pom.xml | 2 +- services/cloudfront/pom.xml | 2 +- services/cloudhsm/pom.xml | 2 +- services/cloudhsmv2/pom.xml | 2 +- services/cloudsearch/pom.xml | 2 +- services/cloudsearchdomain/pom.xml | 2 +- services/cloudtrail/pom.xml | 2 +- services/cloudwatch/pom.xml | 2 +- services/cloudwatchevents/pom.xml | 2 +- services/cloudwatchlogs/pom.xml | 2 +- services/codeartifact/pom.xml | 2 +- services/codebuild/pom.xml | 2 +- services/codecommit/pom.xml | 2 +- services/codedeploy/pom.xml | 2 +- services/codeguruprofiler/pom.xml | 2 +- services/codegurureviewer/pom.xml | 2 +- services/codepipeline/pom.xml | 2 +- services/codestar/pom.xml | 2 +- services/codestarconnections/pom.xml | 2 +- services/codestarnotifications/pom.xml | 2 +- services/cognitoidentity/pom.xml | 2 +- services/cognitoidentityprovider/pom.xml | 2 +- services/cognitosync/pom.xml | 2 +- services/comprehend/pom.xml | 2 +- services/comprehendmedical/pom.xml | 2 +- services/computeoptimizer/pom.xml | 2 +- services/config/pom.xml | 2 +- services/connect/pom.xml | 2 +- services/connectcontactlens/pom.xml | 2 +- services/connectparticipant/pom.xml | 2 +- services/costandusagereport/pom.xml | 2 +- services/costexplorer/pom.xml | 2 +- services/customerprofiles/pom.xml | 2 +- services/databasemigration/pom.xml | 2 +- services/databrew/pom.xml | 2 +- services/dataexchange/pom.xml | 2 +- services/datapipeline/pom.xml | 2 +- services/datasync/pom.xml | 2 +- services/dax/pom.xml | 2 +- services/detective/pom.xml | 2 +- services/devicefarm/pom.xml | 2 +- services/devopsguru/pom.xml | 2 +- services/directconnect/pom.xml | 2 +- services/directory/pom.xml | 2 +- services/dlm/pom.xml | 2 +- services/docdb/pom.xml | 2 +- services/dynamodb/pom.xml | 2 +- services/ebs/pom.xml | 2 +- services/ec2/pom.xml | 2 +- services/ec2instanceconnect/pom.xml | 2 +- services/ecr/pom.xml | 2 +- services/ecrpublic/pom.xml | 2 +- services/ecs/pom.xml | 2 +- services/efs/pom.xml | 2 +- services/eks/pom.xml | 2 +- services/elasticache/pom.xml | 2 +- services/elasticbeanstalk/pom.xml | 2 +- services/elasticinference/pom.xml | 2 +- services/elasticloadbalancing/pom.xml | 2 +- services/elasticloadbalancingv2/pom.xml | 2 +- services/elasticsearch/pom.xml | 2 +- services/elastictranscoder/pom.xml | 2 +- services/emr/pom.xml | 2 +- services/emrcontainers/pom.xml | 2 +- services/eventbridge/pom.xml | 2 +- services/finspace/pom.xml | 2 +- services/finspacedata/pom.xml | 2 +- services/firehose/pom.xml | 2 +- services/fis/pom.xml | 2 +- services/fms/pom.xml | 2 +- services/forecast/pom.xml | 2 +- services/forecastquery/pom.xml | 2 +- services/frauddetector/pom.xml | 2 +- services/fsx/pom.xml | 2 +- services/gamelift/pom.xml | 2 +- services/glacier/pom.xml | 2 +- services/globalaccelerator/pom.xml | 2 +- services/glue/pom.xml | 2 +- services/greengrass/pom.xml | 2 +- services/greengrassv2/pom.xml | 2 +- services/groundstation/pom.xml | 2 +- services/guardduty/pom.xml | 2 +- services/health/pom.xml | 2 +- services/healthlake/pom.xml | 2 +- services/honeycode/pom.xml | 2 +- services/iam/pom.xml | 2 +- services/identitystore/pom.xml | 2 +- services/imagebuilder/pom.xml | 2 +- services/inspector/pom.xml | 2 +- services/iot/pom.xml | 2 +- services/iot1clickdevices/pom.xml | 2 +- services/iot1clickprojects/pom.xml | 2 +- services/iotanalytics/pom.xml | 2 +- services/iotdataplane/pom.xml | 2 +- services/iotdeviceadvisor/pom.xml | 2 +- services/iotevents/pom.xml | 2 +- services/ioteventsdata/pom.xml | 2 +- services/iotfleethub/pom.xml | 2 +- services/iotjobsdataplane/pom.xml | 2 +- services/iotsecuretunneling/pom.xml | 2 +- services/iotsitewise/pom.xml | 2 +- services/iotthingsgraph/pom.xml | 2 +- services/iotwireless/pom.xml | 2 +- services/ivs/pom.xml | 2 +- services/kafka/pom.xml | 2 +- services/kendra/pom.xml | 2 +- services/kinesis/pom.xml | 2 +- services/kinesisanalytics/pom.xml | 2 +- services/kinesisanalyticsv2/pom.xml | 2 +- services/kinesisvideo/pom.xml | 2 +- services/kinesisvideoarchivedmedia/pom.xml | 2 +- services/kinesisvideomedia/pom.xml | 2 +- services/kinesisvideosignaling/pom.xml | 2 +- services/kms/pom.xml | 2 +- services/lakeformation/pom.xml | 2 +- services/lambda/pom.xml | 2 +- services/lexmodelbuilding/pom.xml | 2 +- services/lexmodelsv2/pom.xml | 2 +- services/lexruntime/pom.xml | 2 +- services/lexruntimev2/pom.xml | 2 +- services/licensemanager/pom.xml | 2 +- services/lightsail/pom.xml | 2 +- services/location/pom.xml | 2 +- services/lookoutequipment/pom.xml | 2 +- services/lookoutmetrics/pom.xml | 2 +- services/lookoutvision/pom.xml | 2 +- services/machinelearning/pom.xml | 2 +- services/macie/pom.xml | 2 +- services/macie2/pom.xml | 2 +- services/managedblockchain/pom.xml | 2 +- services/marketplacecatalog/pom.xml | 2 +- services/marketplacecommerceanalytics/pom.xml | 2 +- services/marketplaceentitlement/pom.xml | 2 +- services/marketplacemetering/pom.xml | 2 +- services/mediaconnect/pom.xml | 2 +- services/mediaconvert/pom.xml | 2 +- services/medialive/pom.xml | 2 +- services/mediapackage/pom.xml | 2 +- services/mediapackagevod/pom.xml | 2 +- services/mediastore/pom.xml | 2 +- services/mediastoredata/pom.xml | 2 +- services/mediatailor/pom.xml | 2 +- services/mgn/pom.xml | 2 +- services/migrationhub/pom.xml | 2 +- services/migrationhubconfig/pom.xml | 2 +- services/mobile/pom.xml | 2 +- services/mq/pom.xml | 2 +- services/mturk/pom.xml | 2 +- services/mwaa/pom.xml | 2 +- services/neptune/pom.xml | 2 +- services/networkfirewall/pom.xml | 2 +- services/networkmanager/pom.xml | 2 +- services/nimble/pom.xml | 2 +- services/opsworks/pom.xml | 2 +- services/opsworkscm/pom.xml | 2 +- services/organizations/pom.xml | 2 +- services/outposts/pom.xml | 2 +- services/personalize/pom.xml | 2 +- services/personalizeevents/pom.xml | 2 +- services/personalizeruntime/pom.xml | 2 +- services/pi/pom.xml | 2 +- services/pinpoint/pom.xml | 2 +- services/pinpointemail/pom.xml | 2 +- services/pinpointsmsvoice/pom.xml | 2 +- services/polly/pom.xml | 2 +- services/pom.xml | 5 +- services/pricing/pom.xml | 2 +- services/proton/pom.xml | 2 +- services/qldb/pom.xml | 2 +- services/qldbsession/pom.xml | 2 +- services/quicksight/pom.xml | 2 +- services/ram/pom.xml | 2 +- services/rds/pom.xml | 2 +- services/rdsdata/pom.xml | 2 +- services/redshift/pom.xml | 2 +- services/redshiftdata/pom.xml | 2 +- services/rekognition/pom.xml | 2 +- services/resourcegroups/pom.xml | 2 +- services/resourcegroupstaggingapi/pom.xml | 2 +- services/robomaker/pom.xml | 2 +- services/route53/pom.xml | 2 +- services/route53domains/pom.xml | 2 +- services/route53recoverycluster/pom.xml | 2 +- services/route53recoverycontrolconfig/pom.xml | 2 +- services/route53recoveryreadiness/pom.xml | 2 +- services/route53resolver/pom.xml | 2 +- services/s3/pom.xml | 2 +- services/s3control/pom.xml | 2 +- services/s3outposts/pom.xml | 2 +- services/sagemaker/pom.xml | 2 +- services/sagemakera2iruntime/pom.xml | 2 +- services/sagemakeredge/pom.xml | 2 +- services/sagemakerfeaturestoreruntime/pom.xml | 2 +- services/sagemakerruntime/pom.xml | 2 +- services/savingsplans/pom.xml | 2 +- services/schemas/pom.xml | 2 +- services/secretsmanager/pom.xml | 2 +- services/securityhub/pom.xml | 2 +- .../serverlessapplicationrepository/pom.xml | 2 +- services/servicecatalog/pom.xml | 2 +- services/servicecatalogappregistry/pom.xml | 2 +- services/servicediscovery/pom.xml | 2 +- services/servicequotas/pom.xml | 2 +- services/ses/pom.xml | 2 +- services/sesv2/pom.xml | 2 +- services/sfn/pom.xml | 2 +- services/shield/pom.xml | 2 +- services/signer/pom.xml | 2 +- services/sms/pom.xml | 2 +- services/snowball/pom.xml | 2 +- services/sns/pom.xml | 2 +- services/sqs/pom.xml | 2 +- services/ssm/pom.xml | 2 +- services/ssmcontacts/pom.xml | 2 +- services/ssmincidents/pom.xml | 2 +- services/sso/pom.xml | 2 +- services/ssoadmin/pom.xml | 2 +- services/ssooidc/pom.xml | 2 +- services/storagegateway/pom.xml | 2 +- services/sts/pom.xml | 2 +- services/support/pom.xml | 2 +- services/swf/pom.xml | 2 +- services/synthetics/pom.xml | 2 +- services/textract/pom.xml | 2 +- services/timestreamquery/pom.xml | 2 +- services/timestreamwrite/pom.xml | 2 +- services/transcribe/pom.xml | 2 +- services/transcribestreaming/pom.xml | 2 +- services/transfer/pom.xml | 2 +- services/translate/pom.xml | 2 +- services/waf/pom.xml | 2 +- services/wafv2/pom.xml | 2 +- services/wellarchitected/pom.xml | 2 +- services/workdocs/pom.xml | 2 +- services/worklink/pom.xml | 2 +- services/workmail/pom.xml | 2 +- services/workmailmessageflow/pom.xml | 2 +- services/workspaces/pom.xml | 2 +- services/xray/pom.xml | 2 +- test/auth-sts-testing/pom.xml | 2 +- test/codegen-generated-classes-test/pom.xml | 2 +- test/http-client-tests/pom.xml | 2 +- test/module-path-tests/pom.xml | 2 +- test/protocol-tests-core/pom.xml | 2 +- test/protocol-tests/pom.xml | 2 +- test/sdk-benchmarks/pom.xml | 2 +- test/sdk-native-image-test/pom.xml | 2 +- test/service-test-utils/pom.xml | 2 +- test/stability-tests/pom.xml | 2 +- test/test-utils/pom.xml | 2 +- test/tests-coverage-reporting/pom.xml | 2 +- third-party/pom.xml | 2 +- third-party/third-party-jackson-core/pom.xml | 2 +- .../pom.xml | 2 +- utils/pom.xml | 2 +- 342 files changed, 491 insertions(+), 403 deletions(-) create mode 100644 .changes/2.17.6.json delete mode 100644 .changes/next-release/feature-AWSBatch-e691b83.json delete mode 100644 .changes/next-release/feature-AWSIoTAnalytics-738678e.json delete mode 100644 .changes/next-release/feature-AWSIoTWireless-0048165.json delete mode 100644 .changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json delete mode 100644 .changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json delete mode 100644 .changes/next-release/feature-AWSSDKforJavav2-bedacd4.json delete mode 100644 .changes/next-release/feature-AWSShield-67ae7d6.json delete mode 100644 .changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json delete mode 100644 .changes/next-release/feature-AmazonQuickSight-5e5ea2b.json delete mode 100644 .changes/next-release/feature-AmazonRoute53-fb8b7d7.json delete mode 100644 .changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json delete mode 100644 .changes/next-release/feature-Route53RecoveryCluster-5435d76.json diff --git a/.changes/2.17.6.json b/.changes/2.17.6.json new file mode 100644 index 000000000000..f396cd15beb3 --- /dev/null +++ b/.changes/2.17.6.json @@ -0,0 +1,78 @@ +{ + "version": "2.17.6", + "date": "2021-07-27", + "entries": [ + { + "type": "feature", + "category": "AWS Route53 Recovery Readiness", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed." + }, + { + "type": "feature", + "category": "Route53 Recovery Cluster", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Data Plane APIs help you update the state (On/Off) of the routing controls to reroute traffic across application replicas in a 100% available manner." + }, + { + "type": "feature", + "category": "AWS Route53 Recovery Control Config", + "contributor": "", + "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Configuration APIs help you create and delete clusters, control panels, routing controls and safety rules. State changes (On/Off) of routing controls are not part of configuration APIs." + }, + { + "type": "feature", + "category": "AWS SDK for Java v2", + "contributor": "", + "description": "Updated service endpoint metadata." + }, + { + "type": "feature", + "category": "AWS IoT Analytics", + "contributor": "", + "description": "IoT Analytics now supports creating a dataset resource with IoT SiteWise MultiLayerStorage data stores, enabling customers to query industrial data within the service. This release includes adding JOIN functionality for customers to query multiple data sources in a dataset." + }, + { + "type": "feature", + "category": "Amazon Route 53", + "contributor": "", + "description": "This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller." + }, + { + "type": "feature", + "category": "AWS Shield", + "contributor": "", + "description": "Change name of DDoS Response Team (DRT) to Shield Response Team (SRT)" + }, + { + "type": "feature", + "category": "AWS IoT Wireless", + "contributor": "", + "description": "Add SidewalkManufacturingSn as an identifier to allow Customer to query WirelessDevice, in the response, AmazonId is added in the case that Sidewalk device is return." + }, + { + "type": "feature", + "category": "AWS Batch", + "contributor": "", + "description": "Add support for ListJob filters" + }, + { + "type": "feature", + "category": "Amazon QuickSight", + "contributor": "", + "description": "Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight" + }, + { + "type": "feature", + "category": "Redshift Data API Service", + "contributor": "", + "description": "Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction." + }, + { + "type": "feature", + "category": "Amazon Lex Model Building V2", + "contributor": "", + "description": "Add waiters that automatically poll for resource status for asynchronous operations, such as building a bot" + } + ] +} \ No newline at end of file diff --git a/.changes/next-release/feature-AWSBatch-e691b83.json b/.changes/next-release/feature-AWSBatch-e691b83.json deleted file mode 100644 index a6c617c0e7e7..000000000000 --- a/.changes/next-release/feature-AWSBatch-e691b83.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Batch", - "contributor": "", - "description": "Add support for ListJob filters" -} diff --git a/.changes/next-release/feature-AWSIoTAnalytics-738678e.json b/.changes/next-release/feature-AWSIoTAnalytics-738678e.json deleted file mode 100644 index 0ea164cc01c7..000000000000 --- a/.changes/next-release/feature-AWSIoTAnalytics-738678e.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS IoT Analytics", - "contributor": "", - "description": "IoT Analytics now supports creating a dataset resource with IoT SiteWise MultiLayerStorage data stores, enabling customers to query industrial data within the service. This release includes adding JOIN functionality for customers to query multiple data sources in a dataset." -} diff --git a/.changes/next-release/feature-AWSIoTWireless-0048165.json b/.changes/next-release/feature-AWSIoTWireless-0048165.json deleted file mode 100644 index caddaa4a63c2..000000000000 --- a/.changes/next-release/feature-AWSIoTWireless-0048165.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS IoT Wireless", - "contributor": "", - "description": "Add SidewalkManufacturingSn as an identifier to allow Customer to query WirelessDevice, in the response, AmazonId is added in the case that Sidewalk device is return." -} diff --git a/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json b/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json deleted file mode 100644 index dc61b763563d..000000000000 --- a/.changes/next-release/feature-AWSRoute53RecoveryControlConfig-a53438f.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Route53 Recovery Control Config", - "contributor": "", - "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Configuration APIs help you create and delete clusters, control panels, routing controls and safety rules. State changes (On/Off) of routing controls are not part of configuration APIs." -} diff --git a/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json b/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json deleted file mode 100644 index 276212334aa8..000000000000 --- a/.changes/next-release/feature-AWSRoute53RecoveryReadiness-3dba109.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Route53 Recovery Readiness", - "contributor": "", - "description": "Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed." -} diff --git a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json deleted file mode 100644 index ae3f84993e9e..000000000000 --- a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS SDK for Java v2", - "contributor": "", - "description": "Updated service endpoint metadata." -} diff --git a/.changes/next-release/feature-AWSShield-67ae7d6.json b/.changes/next-release/feature-AWSShield-67ae7d6.json deleted file mode 100644 index d13d0ffb855a..000000000000 --- a/.changes/next-release/feature-AWSShield-67ae7d6.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Shield", - "contributor": "", - "description": "Change name of DDoS Response Team (DRT) to Shield Response Team (SRT)" -} diff --git a/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json b/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json deleted file mode 100644 index 0f0798207efb..000000000000 --- a/.changes/next-release/feature-AmazonLexModelBuildingV2-77f6e9c.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Lex Model Building V2", - "contributor": "", - "description": "Add waiters that automatically poll for resource status for asynchronous operations, such as building a bot" -} diff --git a/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json b/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json deleted file mode 100644 index 29d9d5c96507..000000000000 --- a/.changes/next-release/feature-AmazonQuickSight-5e5ea2b.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon QuickSight", - "contributor": "", - "description": "Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight" -} diff --git a/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json b/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json deleted file mode 100644 index 24c22722aa89..000000000000 --- a/.changes/next-release/feature-AmazonRoute53-fb8b7d7.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Route 53", - "contributor": "", - "description": "This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller." -} diff --git a/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json b/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json deleted file mode 100644 index e603c97c167d..000000000000 --- a/.changes/next-release/feature-RedshiftDataAPIService-c4e58cd.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Redshift Data API Service", - "contributor": "", - "description": "Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction." -} diff --git a/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json b/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json deleted file mode 100644 index 03703843dfce..000000000000 --- a/.changes/next-release/feature-Route53RecoveryCluster-5435d76.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Route53 Recovery Cluster", - "contributor": "", - "description": "Amazon Route 53 Application Recovery Controller's routing control - Routing Control Data Plane APIs help you update the state (On/Off) of the routing controls to reroute traffic across application replicas in a 100% available manner." -} diff --git a/CHANGELOG.md b/CHANGELOG.md index 423f0fecd6d2..9afd81fe3fac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,52 @@ +# __2.17.6__ __2021-07-27__ +## __AWS Batch__ + - ### Features + - Add support for ListJob filters + +## __AWS IoT Analytics__ + - ### Features + - IoT Analytics now supports creating a dataset resource with IoT SiteWise MultiLayerStorage data stores, enabling customers to query industrial data within the service. This release includes adding JOIN functionality for customers to query multiple data sources in a dataset. + +## __AWS IoT Wireless__ + - ### Features + - Add SidewalkManufacturingSn as an identifier to allow Customer to query WirelessDevice, in the response, AmazonId is added in the case that Sidewalk device is return. + +## __AWS Route53 Recovery Control Config__ + - ### Features + - Amazon Route 53 Application Recovery Controller's routing control - Routing Control Configuration APIs help you create and delete clusters, control panels, routing controls and safety rules. State changes (On/Off) of routing controls are not part of configuration APIs. + +## __AWS Route53 Recovery Readiness__ + - ### Features + - Amazon Route 53 Application Recovery Controller's readiness check capability continually monitors resource quotas, capacity, and network routing policies to ensure that the recovery environment is scaled and configured to take over when needed. + +## __AWS SDK for Java v2__ + - ### Features + - Updated service endpoint metadata. + +## __AWS Shield__ + - ### Features + - Change name of DDoS Response Team (DRT) to Shield Response Team (SRT) + +## __Amazon Lex Model Building V2__ + - ### Features + - Add waiters that automatically poll for resource status for asynchronous operations, such as building a bot + +## __Amazon QuickSight__ + - ### Features + - Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight + +## __Amazon Route 53__ + - ### Features + - This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller. + +## __Redshift Data API Service__ + - ### Features + - Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction. + +## __Route53 Recovery Cluster__ + - ### Features + - Amazon Route 53 Application Recovery Controller's routing control - Routing Control Data Plane APIs help you update the state (On/Off) of the routing controls to reroute traffic across application replicas in a 100% available manner. + # __2.17.5__ __2021-07-26__ ## __AWS Proton__ - ### Features diff --git a/README.md b/README.md index f5dc1307a415..8b6799c93334 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ To automatically manage module versions (currently all modules have the same ver