diff --git a/CHANGELOG.md b/CHANGELOG.md
index 25065ef33d..0db857628c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,23 @@
+Release v1.40.9 (2021-07-27)
+===
+
+### Service Client Updates
+* `service/batch`: Updates service API and documentation
+ * Add support for ListJob filters
+* `service/iotanalytics`: Updates service API and documentation
+* `service/iotwireless`: Updates service API and documentation
+* `service/models.lex.v2`: Updates service waiters
+* `service/quicksight`: Updates service API and documentation
+ * Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight
+* `service/redshift-data`: Updates service API and documentation
+* `service/route53`: Updates service API and documentation
+ * This release adds support for the RECOVERY_CONTROL health check type to be used in conjunction with Route53 Application Recovery Controller.
+* `service/route53-recovery-cluster`: Adds new service
+* `service/route53-recovery-control-config`: Adds new service
+* `service/route53-recovery-readiness`: Adds new service
+* `service/shield`: Updates service documentation
+ * Change name of DDoS Response Team (DRT) to Shield Response Team (SRT)
+
Release v1.40.8 (2021-07-26)
===
diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go
index bb7c47d5d3..d189be5f7f 100644
--- a/aws/endpoints/defaults.go
+++ b/aws/endpoints/defaults.go
@@ -1381,6 +1381,7 @@ var awsPartition = partition{
"ap-east-1": endpoint{},
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
+ "ap-northeast-3": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
@@ -2887,11 +2888,41 @@ var awsPartition = partition{
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
- "sa-east-1": endpoint{},
- "us-east-1": endpoint{},
- "us-east-2": endpoint{},
- "us-west-1": endpoint{},
- "us-west-2": endpoint{},
+ "fips-ca-central-1": endpoint{
+ Hostname: "emr-containers-fips.ca-central-1.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "ca-central-1",
+ },
+ },
+ "fips-us-east-1": endpoint{
+ Hostname: "emr-containers-fips.us-east-1.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-east-1",
+ },
+ },
+ "fips-us-east-2": endpoint{
+ Hostname: "emr-containers-fips.us-east-2.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-east-2",
+ },
+ },
+ "fips-us-west-1": endpoint{
+ Hostname: "emr-containers-fips.us-west-1.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-west-1",
+ },
+ },
+ "fips-us-west-2": endpoint{
+ Hostname: "emr-containers-fips.us-west-2.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-west-2",
+ },
+ },
+ "sa-east-1": endpoint{},
+ "us-east-1": endpoint{},
+ "us-east-2": endpoint{},
+ "us-west-1": endpoint{},
+ "us-west-2": endpoint{},
},
},
"entitlement.marketplace": service{
@@ -8137,6 +8168,12 @@ var awscnPartition = partition{
"neptune": service{
Endpoints: endpoints{
+ "cn-north-1": endpoint{
+ Hostname: "rds.cn-north-1.amazonaws.com.cn",
+ CredentialScope: credentialScope{
+ Region: "cn-north-1",
+ },
+ },
"cn-northwest-1": endpoint{
Hostname: "rds.cn-northwest-1.amazonaws.com.cn",
CredentialScope: credentialScope{
@@ -10956,6 +10993,12 @@ var awsisobPartition = partition{
"us-isob-east-1": endpoint{},
},
},
+ "ds": service{
+
+ Endpoints: endpoints{
+ "us-isob-east-1": endpoint{},
+ },
+ },
"dynamodb": service{
Defaults: endpoint{
Protocols: []string{"http", "https"},
diff --git a/aws/version.go b/aws/version.go
index d5de115a4b..92f244d681 100644
--- a/aws/version.go
+++ b/aws/version.go
@@ -5,4 +5,4 @@ package aws
const SDKName = "aws-sdk-go"
// SDKVersion is the version of this SDK
-const SDKVersion = "1.40.8"
+const SDKVersion = "1.40.9"
diff --git a/models/apis/batch/2016-08-10/api-2.json b/models/apis/batch/2016-08-10/api-2.json
index 4e2ebce880..aed72587a7 100644
--- a/models/apis/batch/2016-08-10/api-2.json
+++ b/models/apis/batch/2016-08-10/api-2.json
@@ -972,7 +972,8 @@
"stoppedAt":{"shape":"Long"},
"container":{"shape":"ContainerSummary"},
"arrayProperties":{"shape":"ArrayPropertiesSummary"},
- "nodeProperties":{"shape":"NodePropertiesSummary"}
+ "nodeProperties":{"shape":"NodePropertiesSummary"},
+ "jobDefinition":{"shape":"String"}
}
},
"JobSummaryList":{
@@ -992,6 +993,13 @@
"value":{"shape":"String"}
}
},
+ "KeyValuesPair":{
+ "type":"structure",
+ "members":{
+ "name":{"shape":"String"},
+ "values":{"shape":"StringList"}
+ }
+ },
"LaunchTemplateSpecification":{
"type":"structure",
"members":{
@@ -1011,6 +1019,10 @@
"swappiness":{"shape":"Integer"}
}
},
+ "ListJobsFilterList":{
+ "type":"list",
+ "member":{"shape":"KeyValuesPair"}
+ },
"ListJobsRequest":{
"type":"structure",
"members":{
@@ -1019,7 +1031,8 @@
"multiNodeJobId":{"shape":"String"},
"jobStatus":{"shape":"JobStatus"},
"maxResults":{"shape":"Integer"},
- "nextToken":{"shape":"String"}
+ "nextToken":{"shape":"String"},
+ "filters":{"shape":"ListJobsFilterList"}
}
},
"ListJobsResponse":{
diff --git a/models/apis/batch/2016-08-10/docs-2.json b/models/apis/batch/2016-08-10/docs-2.json
index 6d220c3c85..a11b2cdb4f 100644
--- a/models/apis/batch/2016-08-10/docs-2.json
+++ b/models/apis/batch/2016-08-10/docs-2.json
@@ -1,25 +1,25 @@
{
"version": "2.0",
- "service": "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.
",
+ "service": "Batch 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.
",
"operations": {
- "CancelJob": "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.
",
- "CreateComputeEnvironment": "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.
",
- "CreateJobQueue": "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.
",
- "DeleteComputeEnvironment": "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.
",
+ "CancelJob": "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.
",
+ "CreateComputeEnvironment": "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.
",
+ "CreateJobQueue": "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": "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.
",
"DeleteJobQueue": "Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.
It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.
",
- "DeregisterJobDefinition": "Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
",
+ "DeregisterJobDefinition": "Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
",
"DescribeComputeEnvironments": "Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
",
"DescribeJobDefinitions": "Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
",
"DescribeJobQueues": "Describes one or more of your job queues.
",
- "DescribeJobs": "Describes a list of AWS Batch jobs.
",
- "ListJobs": "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.
",
- "ListTagsForResource": "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.
",
- "RegisterJobDefinition": "Registers an AWS Batch job definition.
",
- "SubmitJob": "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.
",
- "TagResource": "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.
",
+ "DescribeJobs": "Describes a list of Batch jobs.
",
+ "ListJobs": "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.
",
+ "ListTagsForResource": "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": "Registers an Batch job definition.
",
+ "SubmitJob": "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.
",
+ "TagResource": "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.
",
"TerminateJob": "Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.
",
- "UntagResource": "Deletes specified tags from an AWS Batch resource.
",
- "UpdateComputeEnvironment": "Updates an AWS Batch compute environment.
",
+ "UntagResource": "Deletes specified tags from an Batch resource.
",
+ "UpdateComputeEnvironment": "Updates an Batch compute environment.
",
"UpdateJobQueue": "Updates a job queue.
"
},
"shapes": {
@@ -36,9 +36,9 @@
}
},
"ArrayProperties": {
- "base": "An object representing an AWS Batch array job.
",
+ "base": "An object representing an Batch array job.
",
"refs": {
- "SubmitJobRequest$arrayProperties": "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.
"
+ "SubmitJobRequest$arrayProperties": "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.
"
}
},
"ArrayPropertiesDetail": {
@@ -56,7 +56,7 @@
"AssignPublicIp": {
"base": null,
"refs": {
- "NetworkConfiguration$assignPublicIp": "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\".
"
+ "NetworkConfiguration$assignPublicIp": "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\".
"
}
},
"AttemptContainerDetail": {
@@ -81,9 +81,9 @@
"base": null,
"refs": {
"ContainerDetail$readonlyRootFilesystem": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
",
- "ContainerDetail$privileged": "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.
",
+ "ContainerDetail$privileged": "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.
",
"ContainerProperties$readonlyRootFilesystem": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
",
- "ContainerProperties$privileged": "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.
",
+ "ContainerProperties$privileged": "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.
",
"JobDefinition$propagateTags": "Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
",
"JobDetail$propagateTags": "Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
",
"LinuxParameters$initProcessEnabled": "If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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\"
",
@@ -97,9 +97,9 @@
"CEState": {
"base": null,
"refs": {
- "ComputeEnvironmentDetail$state": "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.
",
- "CreateComputeEnvironmentRequest$state": "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.
",
- "UpdateComputeEnvironmentRequest$state": "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.
"
+ "ComputeEnvironmentDetail$state": "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.
",
+ "CreateComputeEnvironmentRequest$state": "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.
",
+ "UpdateComputeEnvironmentRequest$state": "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.
"
}
},
"CEStatus": {
@@ -111,20 +111,20 @@
"CEType": {
"base": null,
"refs": {
- "ComputeEnvironmentDetail$type": "The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
",
- "CreateComputeEnvironmentRequest$type": "The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
"
+ "ComputeEnvironmentDetail$type": "The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
",
+ "CreateComputeEnvironmentRequest$type": "The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
"
}
},
"CRAllocationStrategy": {
"base": null,
"refs": {
- "ComputeResource$allocationStrategy": "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.
- BEST_FIT (default)
-
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.
- BEST_FIT_PROGRESSIVE
-
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.
- SPOT_CAPACITY_OPTIMIZED
-
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.
"
+ "ComputeResource$allocationStrategy": "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.
- BEST_FIT (default)
-
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.
- BEST_FIT_PROGRESSIVE
-
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.
- SPOT_CAPACITY_OPTIMIZED
-
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.
"
}
},
"CRType": {
"base": null,
"refs": {
- "ComputeResource$type": "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.
"
+ "ComputeResource$type": "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.
"
}
},
"CancelJobRequest": {
@@ -143,7 +143,7 @@
}
},
"ComputeEnvironmentDetail": {
- "base": "An object representing an AWS Batch compute environment.
",
+ "base": "An object representing an Batch compute environment.
",
"refs": {
"ComputeEnvironmentDetailList$member": null
}
@@ -155,7 +155,7 @@
}
},
"ComputeEnvironmentOrder": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"ComputeEnvironmentOrders$member": null
}
@@ -163,22 +163,22 @@
"ComputeEnvironmentOrders": {
"base": null,
"refs": {
- "CreateJobQueueRequest$computeEnvironmentOrder": "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.
",
+ "CreateJobQueueRequest$computeEnvironmentOrder": "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.
",
"JobQueueDetail$computeEnvironmentOrder": "The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
",
- "UpdateJobQueueRequest$computeEnvironmentOrder": "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.
"
+ "UpdateJobQueueRequest$computeEnvironmentOrder": "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.
"
}
},
"ComputeResource": {
- "base": "An object representing an AWS Batch compute resource. For more information, see Compute Environments in the AWS Batch User Guide.
",
+ "base": "An object representing an Batch compute resource. For more information, see Compute Environments in the Batch User Guide.
",
"refs": {
- "ComputeEnvironmentDetail$computeResources": "The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
",
- "CreateComputeEnvironmentRequest$computeResources": "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.
"
+ "ComputeEnvironmentDetail$computeResources": "The compute resources defined for the compute environment. For more information, see Compute Environments in the Batch User Guide.
",
+ "CreateComputeEnvironmentRequest$computeResources": "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.
"
}
},
"ComputeResourceUpdate": {
- "base": "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.
",
+ "base": "An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the Batch User Guide.
",
"refs": {
- "UpdateComputeEnvironmentRequest$computeResources": "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.
"
+ "UpdateComputeEnvironmentRequest$computeResources": "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.
"
}
},
"ContainerDetail": {
@@ -299,7 +299,7 @@
}
},
"Device": {
- "base": "An object representing a container instance host device.
This object isn't applicable to jobs running on Fargate resources and shouldn't be provided.
",
+ "base": "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.
",
"refs": {
"DevicesList$member": null
}
@@ -319,7 +319,7 @@
"DevicesList": {
"base": null,
"refs": {
- "LinuxParameters$devices": "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.
"
+ "LinuxParameters$devices": "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.
"
}
},
"EFSAuthorizationConfig": {
@@ -331,23 +331,23 @@
"EFSAuthorizationConfigIAM": {
"base": null,
"refs": {
- "EFSAuthorizationConfig$iam": "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.
"
+ "EFSAuthorizationConfig$iam": "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.
"
}
},
"EFSTransitEncryption": {
"base": null,
"refs": {
- "EFSVolumeConfiguration$transitEncryption": "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.
"
+ "EFSVolumeConfiguration$transitEncryption": "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.
"
}
},
"EFSVolumeConfiguration": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "Volume$efsVolumeConfiguration": "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.
"
+ "Volume$efsVolumeConfiguration": "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.
"
}
},
"Ec2Configuration": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"Ec2ConfigurationList$member": null
}
@@ -355,15 +355,15 @@
"Ec2ConfigurationList": {
"base": null,
"refs": {
- "ComputeResource$ec2Configuration": "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.
"
+ "ComputeResource$ec2Configuration": "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.
"
}
},
"EnvironmentVariables": {
"base": null,
"refs": {
- "ContainerDetail$environment": "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.
",
- "ContainerOverrides$environment": "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.
",
- "ContainerProperties$environment": "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.
"
+ "ContainerDetail$environment": "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.
",
+ "ContainerOverrides$environment": "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.
",
+ "ContainerProperties$environment": "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.
"
}
},
"EvaluateOnExit": {
@@ -379,16 +379,16 @@
}
},
"FargatePlatformConfiguration": {
- "base": "The platform configuration for jobs running on Fargate resources. For jobs that run on EC2 resources, you shouldn't specify this parameter.
",
+ "base": "The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.
",
"refs": {
- "ContainerDetail$fargatePlatformConfiguration": "The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
",
- "ContainerProperties$fargatePlatformConfiguration": "The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
"
+ "ContainerDetail$fargatePlatformConfiguration": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
",
+ "ContainerProperties$fargatePlatformConfiguration": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
"
}
},
"Host": {
"base": "Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.
",
"refs": {
- "Volume$host": "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.
"
+ "Volume$host": "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.
"
}
},
"ImageIdOverride": {
@@ -400,7 +400,7 @@
"ImageType": {
"base": null,
"refs": {
- "Ec2Configuration$imageType": "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).
- ECS_AL2
-
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.
- ECS_AL2_NVIDIA
-
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.
- ECS_AL1
-
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.
"
+ "Ec2Configuration$imageType": "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).
- ECS_AL2
-
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.
- ECS_AL2_NVIDIA
-
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.
- ECS_AL1
-
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.
"
}
},
"Integer": {
@@ -414,32 +414,32 @@
"ArrayPropertiesSummary$index": "The job index within the array that's associated with this job. This parameter is returned for children of array jobs.
",
"AttemptContainerDetail$exitCode": "The exit code for the job attempt. A non-zero exit code is considered a failure.
",
"ComputeEnvironmentOrder$order": "The order of the compute environment. 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.
",
- "ComputeResource$minvCpus": "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.
",
- "ComputeResource$maxvCpus": "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.
",
- "ComputeResource$desiredvCpus": "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.
",
- "ComputeResource$bidPercentage": "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.
",
- "ComputeResourceUpdate$minvCpus": "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.
",
- "ComputeResourceUpdate$maxvCpus": "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.
",
- "ComputeResourceUpdate$desiredvCpus": "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.
",
+ "ComputeResource$minvCpus": "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.
",
+ "ComputeResource$maxvCpus": "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.
",
+ "ComputeResource$desiredvCpus": "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.
",
+ "ComputeResource$bidPercentage": "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.
",
+ "ComputeResourceUpdate$minvCpus": "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.
",
+ "ComputeResourceUpdate$maxvCpus": "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.
",
+ "ComputeResourceUpdate$desiredvCpus": "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.
",
"ContainerDetail$vcpus": "The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirement object. 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 is required but can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
",
"ContainerDetail$memory": "For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
",
"ContainerDetail$exitCode": "The exit code to return upon completion.
",
- "ContainerOverrides$vcpus": "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.
",
- "ContainerOverrides$memory": "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.
",
- "ContainerProperties$vcpus": "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.
",
- "ContainerProperties$memory": "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.
",
+ "ContainerOverrides$vcpus": "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.
",
+ "ContainerOverrides$memory": "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.
",
+ "ContainerProperties$vcpus": "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.
",
+ "ContainerProperties$memory": "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.
",
"ContainerSummary$exitCode": "The exit code to return upon completion.
",
- "CreateJobQueueRequest$priority": "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.
",
+ "CreateJobQueueRequest$priority": "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.
",
"DescribeComputeEnvironmentsRequest$maxResults": "The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
",
"DescribeJobDefinitionsRequest$maxResults": "The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
",
"DescribeJobQueuesRequest$maxResults": "The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.
",
- "EFSVolumeConfiguration$transitEncryptionPort": "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.
",
+ "EFSVolumeConfiguration$transitEncryptionPort": "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.
",
"JobDefinition$revision": "The revision of the job definition.
",
"JobQueueDetail$priority": "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.
",
- "JobTimeout$attemptDurationSeconds": "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.
",
- "LinuxParameters$sharedMemorySize": "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.
",
- "LinuxParameters$maxSwap": "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.
",
- "LinuxParameters$swappiness": "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.
",
+ "JobTimeout$attemptDurationSeconds": "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.
",
+ "LinuxParameters$sharedMemorySize": "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.
",
+ "LinuxParameters$maxSwap": "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.
",
+ "LinuxParameters$swappiness": "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.
",
"ListJobsRequest$maxResults": "The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.
",
"NodeDetails$nodeIndex": "The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
",
"NodeOverrides$numNodes": "The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:
-
There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).
-
The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.
-
The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
",
@@ -470,7 +470,7 @@
}
},
"JobDefinition": {
- "base": "An object representing an AWS Batch job definition.
",
+ "base": "An object representing an Batch job definition.
",
"refs": {
"JobDefinitionList$member": null
}
@@ -484,11 +484,11 @@
"JobDefinitionType": {
"base": null,
"refs": {
- "RegisterJobDefinitionRequest$type": "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.
"
+ "RegisterJobDefinitionRequest$type": "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.
"
}
},
"JobDependency": {
- "base": "An object representing an AWS Batch job dependency.
",
+ "base": "An object representing an Batch job dependency.
",
"refs": {
"JobDependencyList$member": null
}
@@ -501,7 +501,7 @@
}
},
"JobDetail": {
- "base": "An object representing an AWS Batch job.
",
+ "base": "An object representing an Batch job.
",
"refs": {
"JobDetailList$member": null
}
@@ -513,7 +513,7 @@
}
},
"JobQueueDetail": {
- "base": "An object representing the details of an AWS Batch job queue.
",
+ "base": "An object representing the details of an Batch job queue.
",
"refs": {
"JobQueueDetailList$member": null
}
@@ -527,9 +527,9 @@
"JobStatus": {
"base": null,
"refs": {
- "JobDetail$status": "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.
",
+ "JobDetail$status": "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.
",
"JobSummary$status": "The current status for the job.
",
- "ListJobsRequest$jobStatus": "The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.
"
+ "ListJobsRequest$jobStatus": "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.
"
}
},
"JobSummary": {
@@ -547,10 +547,10 @@
"JobTimeout": {
"base": "An object representing a job timeout configuration.
",
"refs": {
- "JobDefinition$timeout": "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.
",
+ "JobDefinition$timeout": "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.
",
"JobDetail$timeout": "The timeout configuration for the job.
",
- "RegisterJobDefinitionRequest$timeout": "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.
",
- "SubmitJobRequest$timeout": "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.
"
+ "RegisterJobDefinitionRequest$timeout": "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.
",
+ "SubmitJobRequest$timeout": "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.
"
}
},
"KeyValuePair": {
@@ -559,10 +559,16 @@
"EnvironmentVariables$member": null
}
},
+ "KeyValuesPair": {
+ "base": "A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.
",
+ "refs": {
+ "ListJobsFilterList$member": null
+ }
+ },
"LaunchTemplateSpecification": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "ComputeResource$launchTemplate": "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.
"
+ "ComputeResource$launchTemplate": "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.
"
}
},
"LinuxParameters": {
@@ -572,6 +578,12 @@
"ContainerProperties$linuxParameters": "Linux-specific modifications that are applied to the container, such as details for device mappings.
"
}
},
+ "ListJobsFilterList": {
+ "base": null,
+ "refs": {
+ "ListJobsRequest$filters": "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.
- JOB_NAME
-
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.
- JOB_DEFINITION
-
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.
- BEFORE_CREATED_AT
-
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.
- AFTER_CREATED_AT
-
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.
"
+ }
+ },
"ListJobsRequest": {
"base": "Contains the parameters for ListJobs.
",
"refs": {
@@ -595,8 +607,8 @@
"LogConfiguration": {
"base": "Log configuration options to send to a custom log driver for the container.
",
"refs": {
- "ContainerDetail$logConfiguration": "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.
",
- "ContainerProperties$logConfiguration": "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.
"
+ "ContainerDetail$logConfiguration": "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.
",
+ "ContainerProperties$logConfiguration": "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.
"
}
},
"LogConfigurationOptionsMap": {
@@ -608,7 +620,7 @@
"LogDriver": {
"base": null,
"refs": {
- "LogConfiguration$logDriver": "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.
- awslogs
-
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.
- fluentd
-
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
-
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.
- journald
-
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
- json-file
-
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
-
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
-
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\"
"
+ "LogConfiguration$logDriver": "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.
- awslogs
-
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.
- fluentd
-
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
- gelf
-
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.
- journald
-
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
- json-file
-
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
- splunk
-
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
- syslog
-
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\"
"
}
},
"Long": {
@@ -638,10 +650,10 @@
}
},
"NetworkConfiguration": {
- "base": "The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
",
+ "base": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
",
"refs": {
- "ContainerDetail$networkConfiguration": "The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
",
- "ContainerProperties$networkConfiguration": "The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
"
+ "ContainerDetail$networkConfiguration": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
",
+ "ContainerProperties$networkConfiguration": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
"
}
},
"NetworkInterface": {
@@ -664,23 +676,23 @@
}
},
"NodeOverrides": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "SubmitJobRequest$nodeOverrides": "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.
"
+ "SubmitJobRequest$nodeOverrides": "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.
"
}
},
"NodeProperties": {
"base": "An object representing the node properties of a multi-node parallel job.
",
"refs": {
"JobDefinition$nodeProperties": "An object with various properties specific to multi-node parallel jobs.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
",
- "JobDetail$nodeProperties": "An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs running on Fargate resources.
",
- "RegisterJobDefinitionRequest$nodeProperties": "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.
"
+ "JobDetail$nodeProperties": "An object representing the node properties of a multi-node parallel job.
This isn't applicable to jobs that are running on Fargate resources.
",
+ "RegisterJobDefinitionRequest$nodeProperties": "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.
"
}
},
"NodePropertiesSummary": {
"base": "An object representing the properties of a node that's associated with a multi-node parallel job.
",
"refs": {
- "JobSummary$nodeProperties": "The node properties for a single node in a job summary list.
This isn't applicable to jobs running on Fargate resources.
"
+ "JobSummary$nodeProperties": "The node properties for a single node in a job summary list.
This isn't applicable to jobs that are running on Fargate resources.
"
}
},
"NodePropertyOverride": {
@@ -710,7 +722,7 @@
"ParametersMap": {
"base": null,
"refs": {
- "JobDefinition$parameters": "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.
",
+ "JobDefinition$parameters": "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.
",
"JobDetail$parameters": "Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
",
"RegisterJobDefinitionRequest$parameters": "Default parameter substitution placeholders to 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.
",
"SubmitJobRequest$parameters": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
"
@@ -767,7 +779,7 @@
}
},
"RetryStrategy": {
- "base": "The retry strategy associated with a job. For more information, see Automated job retries in the AWS Batch User Guide.
",
+ "base": "The retry strategy associated with a job. For more information, see Automated job retries in the Batch User Guide.
",
"refs": {
"JobDefinition$retryStrategy": "The retry strategy to use for failed jobs that are submitted with this job definition.
",
"JobDetail$retryStrategy": "The retry strategy to use for this job if an attempt fails.
",
@@ -776,7 +788,7 @@
}
},
"Secret": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"SecretList$member": null
}
@@ -784,9 +796,9 @@
"SecretList": {
"base": null,
"refs": {
- "ContainerDetail$secrets": "The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
",
- "ContainerProperties$secrets": "The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
",
- "LogConfiguration$secretOptions": "The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
"
+ "ContainerDetail$secrets": "The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.
",
+ "ContainerProperties$secrets": "The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
",
+ "LogConfiguration$secretOptions": "The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.
"
}
},
"ServerException": {
@@ -801,40 +813,40 @@
"AttemptContainerDetail$containerInstanceArn": "The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
",
"AttemptContainerDetail$taskArn": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.
",
"AttemptContainerDetail$reason": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
",
- "AttemptContainerDetail$logStreamName": "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.
",
+ "AttemptContainerDetail$logStreamName": "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.
",
"AttemptDetail$statusReason": "A short, human-readable string to provide additional details about the current status of the job attempt.
",
- "CancelJobRequest$jobId": "The AWS Batch job ID of the job to cancel.
",
- "CancelJobRequest$reason": "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.
",
+ "CancelJobRequest$jobId": "The Batch job ID of the job to cancel.
",
+ "CancelJobRequest$reason": "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.
",
"ClientException$message": null,
"ComputeEnvironmentDetail$computeEnvironmentName": "The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
"ComputeEnvironmentDetail$computeEnvironmentArn": "The Amazon Resource Name (ARN) of the compute environment.
",
"ComputeEnvironmentDetail$ecsClusterArn": "The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
",
"ComputeEnvironmentDetail$statusReason": "A short, human-readable string to provide additional details about the current status of the compute environment.
",
- "ComputeEnvironmentDetail$serviceRole": "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.
",
+ "ComputeEnvironmentDetail$serviceRole": "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.
",
"ComputeEnvironmentOrder$computeEnvironment": "The Amazon Resource Name (ARN) of the compute environment.
",
- "ComputeResource$imageId": "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.
",
- "ComputeResource$ec2KeyPair": "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.
",
- "ComputeResource$instanceRole": "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.
",
- "ComputeResource$placementGroup": "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.
",
- "ComputeResource$spotIamFleetRole": "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.
",
+ "ComputeResource$imageId": "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.
",
+ "ComputeResource$ec2KeyPair": "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.
",
+ "ComputeResource$instanceRole": "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.
",
+ "ComputeResource$placementGroup": "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.
",
+ "ComputeResource$spotIamFleetRole": "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.
",
"ContainerDetail$image": "The image used to start the container.
",
"ContainerDetail$jobRoleArn": "The Amazon Resource Name (ARN) associated with the job upon execution.
",
- "ContainerDetail$executionRoleArn": "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.
",
+ "ContainerDetail$executionRoleArn": "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.
",
"ContainerDetail$user": "The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
",
"ContainerDetail$reason": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
",
"ContainerDetail$containerInstanceArn": "The Amazon Resource Name (ARN) of the container instance that the container is running on.
",
"ContainerDetail$taskArn": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
",
- "ContainerDetail$logStreamName": "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.
",
- "ContainerDetail$instanceType": "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.
",
- "ContainerOverrides$instanceType": "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.
",
+ "ContainerDetail$logStreamName": "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.
",
+ "ContainerDetail$instanceType": "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.
",
+ "ContainerOverrides$instanceType": "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.
",
"ContainerProperties$image": "The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
-
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
-
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
-
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
-
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
",
- "ContainerProperties$jobRoleArn": "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.
",
- "ContainerProperties$executionRoleArn": "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.
",
+ "ContainerProperties$jobRoleArn": "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.
",
+ "ContainerProperties$executionRoleArn": "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.
",
"ContainerProperties$user": "The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
",
- "ContainerProperties$instanceType": "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.
",
+ "ContainerProperties$instanceType": "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.
",
"ContainerSummary$reason": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
",
"CreateComputeEnvironmentRequest$computeEnvironmentName": "The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
- "CreateComputeEnvironmentRequest$serviceRole": "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.
",
+ "CreateComputeEnvironmentRequest$serviceRole": "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.
",
"CreateComputeEnvironmentResponse$computeEnvironmentName": "The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
"CreateComputeEnvironmentResponse$computeEnvironmentArn": "The Amazon Resource Name (ARN) of the compute environment.
",
"CreateJobQueueRequest$jobQueueName": "The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
",
@@ -852,20 +864,20 @@
"DescribeJobQueuesRequest$nextToken": "The nextToken value returned from a previous paginated DescribeJobQueues 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.
",
"DescribeJobQueuesResponse$nextToken": "The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
",
"Device$hostPath": "The path for the device on the host container instance.
",
- "Device$containerPath": "The path inside the container used to expose the host device. By default, the hostPath value is used.
",
+ "Device$containerPath": "The path inside the container that's used to expose the host device. By default, the hostPath value is used.
",
"EFSAuthorizationConfig$accessPointId": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.
",
"EFSVolumeConfiguration$fileSystemId": "The Amazon EFS file system ID to use.
",
- "EFSVolumeConfiguration$rootDirectory": "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.
",
- "EvaluateOnExit$onStatusReason": "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.
",
- "EvaluateOnExit$onReason": "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.
",
- "EvaluateOnExit$onExitCode": "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.
",
- "FargatePlatformConfiguration$platformVersion": "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.
",
+ "EFSVolumeConfiguration$rootDirectory": "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.
",
+ "EvaluateOnExit$onStatusReason": "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.
",
+ "EvaluateOnExit$onReason": "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.
",
+ "EvaluateOnExit$onExitCode": "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.
",
+ "FargatePlatformConfiguration$platformVersion": "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.
",
"Host$sourcePath": "The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
",
"JobDefinition$jobDefinitionName": "The name of the job definition.
",
"JobDefinition$jobDefinitionArn": "The Amazon Resource Name (ARN) for the job definition.
",
"JobDefinition$status": "The status of the job definition.
",
- "JobDefinition$type": "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.
",
- "JobDependency$jobId": "The job ID of the AWS Batch job associated with this dependency.
",
+ "JobDefinition$type": "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.
",
+ "JobDependency$jobId": "The job ID of the Batch job associated with this dependency.
",
"JobDetail$jobArn": "The Amazon Resource Name (ARN) of the job.
",
"JobDetail$jobName": "The name of the job.
",
"JobDetail$jobId": "The ID for the job.
",
@@ -879,17 +891,19 @@
"JobSummary$jobId": "The ID of the job.
",
"JobSummary$jobName": "The name of the job.
",
"JobSummary$statusReason": "A short, human-readable string to provide additional details about the current status of the job.
",
+ "JobSummary$jobDefinition": "The Amazon Resource Name (ARN) of the job definition.
",
"KeyValuePair$name": "The name of the key-value pair. For environment variables, this is the name of the environment variable.
",
"KeyValuePair$value": "The value of the key-value pair. For environment variables, this is the value of the environment variable.
",
+ "KeyValuesPair$name": "The name of the filter. Filter names are case sensitive.
",
"LaunchTemplateSpecification$launchTemplateId": "The ID of the launch template.
",
"LaunchTemplateSpecification$launchTemplateName": "The name of the launch template.
",
- "LaunchTemplateSpecification$version": "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.
",
+ "LaunchTemplateSpecification$version": "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.
",
"ListJobsRequest$jobQueue": "The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
",
"ListJobsRequest$arrayJobId": "The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
",
"ListJobsRequest$multiNodeJobId": "The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
",
"ListJobsRequest$nextToken": "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.
",
"ListJobsResponse$nextToken": "The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
",
- "ListTagsForResourceRequest$resourceArn": "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.
",
+ "ListTagsForResourceRequest$resourceArn": "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.
",
"LogConfigurationOptionsMap$key": null,
"LogConfigurationOptionsMap$value": null,
"MountPoint$containerPath": "The path on the container where the host volume is mounted.
",
@@ -904,9 +918,9 @@
"RegisterJobDefinitionRequest$jobDefinitionName": "The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
"RegisterJobDefinitionResponse$jobDefinitionName": "The name of the job definition.
",
"RegisterJobDefinitionResponse$jobDefinitionArn": "The Amazon Resource Name (ARN) of the job definition.
",
- "ResourceRequirement$value": "The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
- type=\"GPU\"
-
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.
- type=\"MEMORY\"
-
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.
- value = 512
-
VCPU = 0.25
- value = 1024
-
VCPU = 0.25 or 0.5
- value = 2048
-
VCPU = 0.25, 0.5, or 1
- value = 3072
-
VCPU = 0.5, or 1
- value = 4096
-
VCPU = 0.5, 1, or 2
- value = 5120, 6144, or 7168
-
VCPU = 1 or 2
- value = 8192
-
VCPU = 1, 2, or 4
- value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
-
VCPU = 2 or 4
- value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
-
VCPU = 4
- type=\"VCPU\"
-
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
- value = 0.25
-
MEMORY = 512, 1024, or 2048
- value = 0.5
-
MEMORY = 1024, 2048, 3072, or 4096
- value = 1
-
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
- value = 2
-
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
- value = 4
-
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
",
+ "ResourceRequirement$value": "The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
- type=\"GPU\"
-
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.
- type=\"MEMORY\"
-
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.
- value = 512
-
VCPU = 0.25
- value = 1024
-
VCPU = 0.25 or 0.5
- value = 2048
-
VCPU = 0.25, 0.5, or 1
- value = 3072
-
VCPU = 0.5, or 1
- value = 4096
-
VCPU = 0.5, 1, or 2
- value = 5120, 6144, or 7168
-
VCPU = 1 or 2
- value = 8192
-
VCPU = 1, 2, or 4
- value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
-
VCPU = 2 or 4
- value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
-
VCPU = 4
- type=\"VCPU\"
-
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
- value = 0.25
-
MEMORY = 512, 1024, or 2048
- value = 0.5
-
MEMORY = 1024, 2048, 3072, or 4096
- value = 1
-
MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
- value = 2
-
MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
- value = 4
-
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
",
"Secret$name": "The name of the secret.
",
- "Secret$valueFrom": "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.
",
+ "Secret$valueFrom": "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.
",
"ServerException$message": null,
"StringList$member": null,
"SubmitJobRequest$jobName": "The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
@@ -915,16 +929,16 @@
"SubmitJobResponse$jobArn": "The Amazon Resource Name (ARN) for the job.
",
"SubmitJobResponse$jobName": "The name of the job.
",
"SubmitJobResponse$jobId": "The unique identifier for the job.
",
- "TagResourceRequest$resourceArn": "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.
",
+ "TagResourceRequest$resourceArn": "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.
",
"TagsMap$key": null,
"TagsMap$value": null,
- "TerminateJobRequest$jobId": "The AWS Batch job ID of the job to terminate.
",
- "TerminateJobRequest$reason": "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.
",
+ "TerminateJobRequest$jobId": "The Batch job ID of the job to terminate.
",
+ "TerminateJobRequest$reason": "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.
",
"Tmpfs$containerPath": "The absolute file path in the container where the tmpfs volume is mounted.
",
"Ulimit$name": "The type of the ulimit.
",
- "UntagResourceRequest$resourceArn": "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.
",
+ "UntagResourceRequest$resourceArn": "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.
",
"UpdateComputeEnvironmentRequest$computeEnvironment": "The name or full Amazon Resource Name (ARN) of the compute environment to update.
",
- "UpdateComputeEnvironmentRequest$serviceRole": "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.
",
+ "UpdateComputeEnvironmentRequest$serviceRole": "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.
",
"UpdateComputeEnvironmentResponse$computeEnvironmentName": "The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
",
"UpdateComputeEnvironmentResponse$computeEnvironmentArn": "The Amazon Resource Name (ARN) of the compute environment.
",
"UpdateJobQueueRequest$jobQueue": "The name or the Amazon Resource Name (ARN) of the job queue.
",
@@ -936,18 +950,19 @@
"StringList": {
"base": null,
"refs": {
- "ComputeResource$instanceTypes": "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.
",
- "ComputeResource$subnets": "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.
",
- "ComputeResource$securityGroupIds": "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.
",
- "ComputeResourceUpdate$subnets": "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.
",
+ "ComputeResource$instanceTypes": "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.
",
+ "ComputeResource$subnets": "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.
",
+ "ComputeResource$securityGroupIds": "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.
",
+ "ComputeResourceUpdate$subnets": "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.
",
"ComputeResourceUpdate$securityGroupIds": "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.
",
"ContainerDetail$command": "The command that's passed to the container.
",
"ContainerOverrides$command": "The command to send to the container that overrides the default command from the Docker image or the job definition.
",
"ContainerProperties$command": "The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
",
"DescribeComputeEnvironmentsRequest$computeEnvironments": "A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
",
- "DescribeJobDefinitionsRequest$jobDefinitions": "A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
",
+ "DescribeJobDefinitionsRequest$jobDefinitions": "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}.
",
"DescribeJobQueuesRequest$jobQueues": "A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
",
"DescribeJobsRequest$jobs": "A list of up to 100 job IDs.
",
+ "KeyValuesPair$values": "The filter values.
",
"Tmpfs$mountOptions": "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\"
"
}
},
@@ -994,21 +1009,21 @@
"base": null,
"refs": {
"ComputeEnvironmentDetail$tags": "The tags applied to the compute environment.
",
- "CreateComputeEnvironmentRequest$tags": "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.
",
- "CreateJobQueueRequest$tags": "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.
",
+ "CreateComputeEnvironmentRequest$tags": "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.
",
+ "CreateJobQueueRequest$tags": "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.
",
"JobDefinition$tags": "The tags applied to the job definition.
",
"JobDetail$tags": "The tags applied to the job.
",
- "JobQueueDetail$tags": "The tags applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.
",
+ "JobQueueDetail$tags": "The tags applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
",
"ListTagsForResourceResponse$tags": "The tags for the resource.
",
- "RegisterJobDefinitionRequest$tags": "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.
",
- "SubmitJobRequest$tags": "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.
",
- "TagResourceRequest$tags": "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.
"
+ "RegisterJobDefinitionRequest$tags": "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.
",
+ "SubmitJobRequest$tags": "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.
",
+ "TagResourceRequest$tags": "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.
"
}
},
"TagsMap": {
"base": null,
"refs": {
- "ComputeResource$tags": "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.
"
+ "ComputeResource$tags": "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.
"
}
},
"TerminateJobRequest": {
@@ -1022,7 +1037,7 @@
}
},
"Tmpfs": {
- "base": "The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs running on Fargate resources.
",
+ "base": "The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs that are running on Fargate resources.
",
"refs": {
"TmpfsList$member": null
}
@@ -1030,11 +1045,11 @@
"TmpfsList": {
"base": null,
"refs": {
- "LinuxParameters$tmpfs": "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.
"
+ "LinuxParameters$tmpfs": "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.
"
}
},
"Ulimit": {
- "base": "The ulimit settings to pass to the container.
This object isn't applicable to jobs running on Fargate resources.
",
+ "base": "The ulimit settings to pass to the container.
This object isn't applicable to jobs that are running on Fargate resources.
",
"refs": {
"Ulimits$member": null
}
@@ -1042,8 +1057,8 @@
"Ulimits": {
"base": null,
"refs": {
- "ContainerDetail$ulimits": "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.
",
- "ContainerProperties$ulimits": "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.
"
+ "ContainerDetail$ulimits": "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.
",
+ "ContainerProperties$ulimits": "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.
"
}
},
"UntagResourceRequest": {
diff --git a/models/apis/iotanalytics/2017-11-27/api-2.json b/models/apis/iotanalytics/2017-11-27/api-2.json
index 9da55063da..6283b76f88 100644
--- a/models/apis/iotanalytics/2017-11-27/api-2.json
+++ b/models/apis/iotanalytics/2017-11-27/api-2.json
@@ -703,7 +703,7 @@
"type":"string",
"max":128,
"min":1,
- "pattern":"^[a-zA-Z0-9_]+$"
+ "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)"
},
"ChannelStatistics":{
"type":"structure",
@@ -1070,7 +1070,7 @@
"type":"string",
"max":128,
"min":1,
- "pattern":"^[a-zA-Z0-9_]+$"
+ "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)"
},
"DatasetStatus":{
"type":"string",
@@ -1135,11 +1135,24 @@
}
},
"DatastoreArn":{"type":"string"},
+ "DatastoreIotSiteWiseMultiLayerStorage":{
+ "type":"structure",
+ "required":["customerManagedS3Storage"],
+ "members":{
+ "customerManagedS3Storage":{"shape":"IotSiteWiseCustomerManagedDatastoreS3Storage"}
+ }
+ },
+ "DatastoreIotSiteWiseMultiLayerStorageSummary":{
+ "type":"structure",
+ "members":{
+ "customerManagedS3Storage":{"shape":"IotSiteWiseCustomerManagedDatastoreS3StorageSummary"}
+ }
+ },
"DatastoreName":{
"type":"string",
"max":128,
"min":1,
- "pattern":"^[a-zA-Z0-9_]+$"
+ "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)"
},
"DatastorePartition":{
"type":"structure",
@@ -1172,14 +1185,16 @@
"type":"structure",
"members":{
"serviceManagedS3":{"shape":"ServiceManagedDatastoreS3Storage"},
- "customerManagedS3":{"shape":"CustomerManagedDatastoreS3Storage"}
+ "customerManagedS3":{"shape":"CustomerManagedDatastoreS3Storage"},
+ "iotSiteWiseMultiLayerStorage":{"shape":"DatastoreIotSiteWiseMultiLayerStorage"}
}
},
"DatastoreStorageSummary":{
"type":"structure",
"members":{
"serviceManagedS3":{"shape":"ServiceManagedDatastoreS3StorageSummary"},
- "customerManagedS3":{"shape":"CustomerManagedDatastoreS3StorageSummary"}
+ "customerManagedS3":{"shape":"CustomerManagedDatastoreS3StorageSummary"},
+ "iotSiteWiseMultiLayerStorage":{"shape":"DatastoreIotSiteWiseMultiLayerStorageSummary"}
}
},
"DatastoreSummaries":{
@@ -1529,6 +1544,21 @@
"min":1,
"pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"
},
+ "IotSiteWiseCustomerManagedDatastoreS3Storage":{
+ "type":"structure",
+ "required":["bucket"],
+ "members":{
+ "bucket":{"shape":"BucketName"},
+ "keyPrefix":{"shape":"S3KeyPrefix"}
+ }
+ },
+ "IotSiteWiseCustomerManagedDatastoreS3StorageSummary":{
+ "type":"structure",
+ "members":{
+ "bucket":{"shape":"BucketName"},
+ "keyPrefix":{"shape":"S3KeyPrefix"}
+ }
+ },
"JsonConfiguration":{
"type":"structure",
"members":{
@@ -1887,7 +1917,7 @@
"type":"string",
"max":128,
"min":1,
- "pattern":"^[a-zA-Z0-9_]+$"
+ "pattern":"(^(?!_{2}))(^[a-zA-Z0-9_]+$)"
},
"PipelineSummaries":{
"type":"list",
diff --git a/models/apis/iotanalytics/2017-11-27/docs-2.json b/models/apis/iotanalytics/2017-11-27/docs-2.json
index 79a5b922f5..4cd59f6927 100644
--- a/models/apis/iotanalytics/2017-11-27/docs-2.json
+++ b/models/apis/iotanalytics/2017-11-27/docs-2.json
@@ -1,13 +1,13 @@
{
"version": "2.0",
- "service": "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.
",
+ "service": "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.
",
"operations": {
"BatchPutMessage": "Sends messages to a channel.
",
"CancelPipelineReprocessing": "Cancels the reprocessing of data through the pipeline.
",
- "CreateChannel": "Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
",
- "CreateDataset": "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.
",
- "CreateDatasetContent": "Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
",
- "CreateDatastore": "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.
",
+ "CreateChannel": "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": "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.
",
+ "CreateDatasetContent": "Creates the content of a dataset by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).
",
+ "CreateDatastore": "Creates a data store, which is a repository for messages.
",
"CreatePipeline": "Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
",
"DeleteChannel": "Deletes the specified channel.
",
"DeleteDataset": "Deletes the specified dataset.
You do not have to delete the content of the dataset before you perform this operation.
",
@@ -17,24 +17,24 @@
"DescribeChannel": "Retrieves information about a channel.
",
"DescribeDataset": "Retrieves information about a dataset.
",
"DescribeDatastore": "Retrieves information about a data store.
",
- "DescribeLoggingOptions": "Retrieves the current settings of the AWS IoT Analytics logging options.
",
+ "DescribeLoggingOptions": "Retrieves the current settings of the IoT Analytics logging options.
",
"DescribePipeline": "Retrieves information about a pipeline.
",
- "GetDatasetContent": "Retrieves the contents of a data set as presigned URIs.
",
+ "GetDatasetContent": "Retrieves the contents of a dataset as presigned URIs.
",
"ListChannels": "Retrieves a list of channels.
",
- "ListDatasetContents": "Lists information about data set contents that have been created.
",
- "ListDatasets": "Retrieves information about data sets.
",
+ "ListDatasetContents": "Lists information about dataset contents that have been created.
",
+ "ListDatasets": "Retrieves information about datasets.
",
"ListDatastores": "Retrieves a list of data stores.
",
"ListPipelines": "Retrieves a list of pipelines.
",
"ListTagsForResource": "Lists the tags (metadata) that you have assigned to the resource.
",
- "PutLoggingOptions": "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.
",
+ "PutLoggingOptions": "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.
",
"RunPipelineActivity": "Simulates the results of running a pipeline activity on a message payload.
",
"SampleChannelData": "Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
",
"StartPipelineReprocessing": "Starts the reprocessing of raw message data through the pipeline.
",
"TagResource": "Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
",
"UntagResource": "Removes the given tags (metadata) from the resource.
",
- "UpdateChannel": "Updates the settings of a channel.
",
- "UpdateDataset": "Updates the settings of a data set.
",
- "UpdateDatastore": "Updates the settings of a data store.
",
+ "UpdateChannel": "Used to update the settings of a channel.
",
+ "UpdateDataset": "Updates the settings of a dataset.
",
+ "UpdateDatastore": "Used to update the settings of a data store.
",
"UpdatePipeline": "Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
"
},
"shapes": {
@@ -133,8 +133,10 @@
"refs": {
"CustomerManagedChannelS3Storage$bucket": "The name of the S3 bucket in which channel data is stored.
",
"CustomerManagedChannelS3StorageSummary$bucket": "The name of the S3 bucket in which channel data is stored.
",
- "CustomerManagedDatastoreS3Storage$bucket": "The name of the S3 bucket in which data store data is stored.
",
- "CustomerManagedDatastoreS3StorageSummary$bucket": "The name of the S3 bucket in which data store data is stored.
",
+ "CustomerManagedDatastoreS3Storage$bucket": "The name of the Amazon S3 bucket where your data is stored.
",
+ "CustomerManagedDatastoreS3StorageSummary$bucket": "The name of the Amazon S3 bucket where your data is stored.
",
+ "IotSiteWiseCustomerManagedDatastoreS3Storage$bucket": " The name of the Amazon S3 bucket where your data is stored.
",
+ "IotSiteWiseCustomerManagedDatastoreS3StorageSummary$bucket": " The name of the Amazon S3 bucket where your data is stored.
",
"S3DestinationConfiguration$bucket": "The name of the S3 bucket to which dataset contents are delivered.
"
}
},
@@ -202,11 +204,11 @@
}
},
"ChannelStorage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "Channel$storage": "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.
",
- "CreateChannelRequest$channelStorage": "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.
",
- "UpdateChannelRequest$channelStorage": "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.
"
+ "Channel$storage": "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.
",
+ "CreateChannelRequest$channelStorage": "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.
",
+ "UpdateChannelRequest$channelStorage": "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.
"
}
},
"ChannelStorageSummary": {
@@ -236,7 +238,7 @@
"ColumnDataType": {
"base": null,
"refs": {
- "Column$type": "The type of data. For more information about the supported data types, see Common data types in the AWS Glue Developer Guide.
"
+ "Column$type": "The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.
"
}
},
"ColumnName": {
@@ -314,9 +316,9 @@
}
},
"CustomerManagedChannelS3Storage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "ChannelStorage$customerManagedS3": "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.
"
+ "ChannelStorage$customerManagedS3": "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.
"
}
},
"CustomerManagedChannelS3StorageSummary": {
@@ -326,25 +328,25 @@
}
},
"CustomerManagedDatastoreS3Storage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "DatastoreStorage$customerManagedS3": "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.
"
+ "DatastoreStorage$customerManagedS3": "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.
"
}
},
"CustomerManagedDatastoreS3StorageSummary": {
- "base": "Used to store data store data in an S3 bucket that you manage.
",
+ "base": "Contains information about the data store that you manage.
",
"refs": {
- "DatastoreStorageSummary$customerManagedS3": "Used to store data store data in an S3 bucket that you manage.
"
+ "DatastoreStorageSummary$customerManagedS3": "Used to store data in an Amazon S3 bucket managed by IoT Analytics.
"
}
},
"Dataset": {
- "base": "Information about a data set.
",
+ "base": "Information about a dataset.
",
"refs": {
- "DescribeDatasetResponse$dataset": "An object that contains information about the data set.
"
+ "DescribeDatasetResponse$dataset": "An object that contains information about the dataset.
"
}
},
"DatasetAction": {
- "base": "A DatasetAction object that specifies how data set contents are automatically created.
",
+ "base": "A DatasetAction object that specifies how dataset contents are automatically created.
",
"refs": {
"DatasetActions$member": null
}
@@ -352,7 +354,7 @@
"DatasetActionName": {
"base": null,
"refs": {
- "DatasetAction$actionName": "The name of the data set action by which data set contents are automatically created.
",
+ "DatasetAction$actionName": "The name of the dataset action by which dataset contents are automatically created.
",
"DatasetActionSummary$actionName": "The name of the action that automatically creates the dataset's contents.
"
}
},
@@ -377,8 +379,8 @@
"DatasetActions": {
"base": null,
"refs": {
- "CreateDatasetRequest$actions": "A list of actions that create the data set contents.
",
- "Dataset$actions": "The DatasetAction objects that automatically create the data set contents.
",
+ "CreateDatasetRequest$actions": "A list of actions that create the dataset contents.
",
+ "Dataset$actions": "The DatasetAction objects that automatically create the dataset contents.
",
"UpdateDatasetRequest$actions": "A list of DatasetAction objects.
"
}
},
@@ -386,7 +388,7 @@
"base": null,
"refs": {
"CreateDatasetResponse$datasetArn": "The ARN of the dataset.
",
- "Dataset$arn": "The ARN of the data set.
"
+ "Dataset$arn": "The ARN of the dataset.
"
}
},
"DatasetContentDeliveryDestination": {
@@ -412,20 +414,20 @@
"DatasetContentState": {
"base": null,
"refs": {
- "DatasetContentStatus$state": "The state of the data set contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
"
+ "DatasetContentStatus$state": "The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
"
}
},
"DatasetContentStatus": {
- "base": "The state of the data set contents and the reason they are in this state.
",
+ "base": "The state of the dataset contents and the reason they are in this state.
",
"refs": {
- "DatasetContentSummary$status": "The status of the data set contents.
",
- "GetDatasetContentResponse$status": "The status of the data set content.
"
+ "DatasetContentSummary$status": "The status of the dataset contents.
",
+ "GetDatasetContentResponse$status": "The status of the dataset content.
"
}
},
"DatasetContentSummaries": {
"base": null,
"refs": {
- "ListDatasetContentsResponse$datasetContentSummaries": "Summary information about data set contents that have been created.
"
+ "ListDatasetContentsResponse$datasetContentSummaries": "Summary information about dataset contents that have been created.
"
}
},
"DatasetContentSummary": {
@@ -441,7 +443,7 @@
"CreateDatasetContentResponse$versionId": "The version ID of the dataset contents that are being created.
",
"DatasetContentSummary$version": "The version of the dataset contents.
",
"DeleteDatasetContentRequest$versionId": "The version of the dataset whose content is deleted. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to delete the latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.
",
- "GetDatasetContentRequest$versionId": "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.
"
+ "GetDatasetContentRequest$versionId": "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.
"
}
},
"DatasetContentVersionValue": {
@@ -457,7 +459,7 @@
}
},
"DatasetEntry": {
- "base": "The reference to a data set entry.
",
+ "base": "The reference to a dataset entry.
",
"refs": {
"DatasetEntries$member": null
}
@@ -466,25 +468,25 @@
"base": null,
"refs": {
"CreateDatasetContentRequest$datasetName": "The name of the dataset.
",
- "CreateDatasetRequest$datasetName": "The name of the data set.
",
+ "CreateDatasetRequest$datasetName": "The name of the dataset.
",
"CreateDatasetResponse$datasetName": "The name of the dataset.
",
- "Dataset$name": "The name of the data set.
",
+ "Dataset$name": "The name of the dataset.
",
"DatasetContentVersionValue$datasetName": "The name of the dataset whose latest contents are used as input to the notebook or application.
",
- "DatasetSummary$datasetName": "The name of the data set.
",
+ "DatasetSummary$datasetName": "The name of the dataset.
",
"DeleteDatasetContentRequest$datasetName": "The name of the dataset whose content is deleted.
",
- "DeleteDatasetRequest$datasetName": "The name of the data set to delete.
",
- "DescribeDatasetRequest$datasetName": "The name of the data set whose information is retrieved.
",
- "GetDatasetContentRequest$datasetName": "The name of the data set whose contents are retrieved.
",
- "ListDatasetContentsRequest$datasetName": "The name of the data set whose contents information you want to list.
",
+ "DeleteDatasetRequest$datasetName": "The name of the dataset to delete.
",
+ "DescribeDatasetRequest$datasetName": "The name of the dataset whose information is retrieved.
",
+ "GetDatasetContentRequest$datasetName": "The name of the dataset whose contents are retrieved.
",
+ "ListDatasetContentsRequest$datasetName": "The name of the dataset whose contents information you want to list.
",
"TriggeringDataset$name": "The name of the dataset whose content generation triggers the new dataset content generation.
",
- "UpdateDatasetRequest$datasetName": "The name of the data set to update.
"
+ "UpdateDatasetRequest$datasetName": "The name of the dataset to update.
"
}
},
"DatasetStatus": {
"base": null,
"refs": {
- "Dataset$status": "The status of the data set.
",
- "DatasetSummary$status": "The status of the data set.
"
+ "Dataset$status": "The status of the dataset.
",
+ "DatasetSummary$status": "The status of the dataset.
"
}
},
"DatasetSummaries": {
@@ -494,13 +496,13 @@
}
},
"DatasetSummary": {
- "base": "A summary of information about a data set.
",
+ "base": "A summary of information about a dataset.
",
"refs": {
"DatasetSummaries$member": null
}
},
"DatasetTrigger": {
- "base": "The DatasetTrigger that specifies when the data set is automatically updated.
",
+ "base": "The DatasetTrigger that specifies when the dataset is automatically updated.
",
"refs": {
"DatasetTriggers$member": null
}
@@ -508,9 +510,9 @@
"DatasetTriggers": {
"base": null,
"refs": {
- "CreateDatasetRequest$triggers": "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.
",
- "Dataset$triggers": "The DatasetTrigger objects that specify when the data set is automatically updated.
",
- "DatasetSummary$triggers": "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
",
+ "CreateDatasetRequest$triggers": "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.
",
+ "Dataset$triggers": "The DatasetTrigger objects that specify when the dataset is automatically updated.
",
+ "DatasetSummary$triggers": "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
",
"UpdateDatasetRequest$triggers": "A list of DatasetTrigger objects. The list can be empty or can contain up to five DatasetTrigger objects.
"
}
},
@@ -533,6 +535,18 @@
"Datastore$arn": "The ARN of the data store.
"
}
},
+ "DatastoreIotSiteWiseMultiLayerStorage": {
+ "base": " 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.
",
+ "refs": {
+ "DatastoreStorage$iotSiteWiseMultiLayerStorage": " 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": {
+ "base": " Contains information about the data store that you manage, which stores data used by IoT SiteWise.
",
+ "refs": {
+ "DatastoreStorageSummary$iotSiteWiseMultiLayerStorage": " Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
"
+ }
+ },
"DatastoreName": {
"base": null,
"refs": {
@@ -547,17 +561,17 @@
}
},
"DatastorePartition": {
- "base": " A single partition in a data store.
",
+ "base": " A single dimension to partition a data store. The dimension must be an AttributePartition or a TimestampPartition.
",
"refs": {
"Partitions$member": null
}
},
"DatastorePartitions": {
- "base": " Contains information about partitions in a data store.
",
+ "base": " Contains information about the partition dimensions in a data store.
",
"refs": {
- "CreateDatastoreRequest$datastorePartitions": " Contains information about the partitions in a data store.
",
- "Datastore$datastorePartitions": " Contains information about the partitions in a data store.
",
- "DatastoreSummary$datastorePartitions": " Contains information about the partitions in a data store.
"
+ "CreateDatastoreRequest$datastorePartitions": " Contains information about the partition dimensions in a data store.
",
+ "Datastore$datastorePartitions": " Contains information about the partition dimensions in a data store.
",
+ "DatastoreSummary$datastorePartitions": " Contains information about the partition dimensions in a data store.
"
}
},
"DatastoreStatistics": {
@@ -574,17 +588,17 @@
}
},
"DatastoreStorage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "CreateDatastoreRequest$datastoreStorage": "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.
",
- "Datastore$storage": "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.
",
- "UpdateDatastoreRequest$datastoreStorage": "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.
"
+ "CreateDatastoreRequest$datastoreStorage": "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.
",
+ "Datastore$storage": "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.
",
+ "UpdateDatastoreRequest$datastoreStorage": "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.
"
}
},
"DatastoreStorageSummary": {
- "base": "Where data store data is stored.
",
+ "base": "Contains information about your data store.
",
"refs": {
- "DatastoreSummary$datastoreStorage": "Where data store data is stored.
"
+ "DatastoreSummary$datastoreStorage": "Where data in a data store is stored.
"
}
},
"DatastoreSummaries": {
@@ -631,7 +645,7 @@
}
},
"DeltaTimeSessionWindowConfiguration": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"LateDataRuleConfiguration$deltaTimeSessionWindowConfiguration": "The information needed to configure a delta time session window.
"
}
@@ -687,15 +701,15 @@
}
},
"DeviceRegistryEnrichActivity": {
- "base": "An activity that adds data from the AWS IoT device registry to your message.
",
+ "base": "An activity that adds data from the IoT device registry to your message.
",
"refs": {
- "PipelineActivity$deviceRegistryEnrich": "Adds data from the AWS IoT device registry to your message.
"
+ "PipelineActivity$deviceRegistryEnrich": "Adds data from the IoT device registry to your message.
"
}
},
"DeviceShadowEnrichActivity": {
- "base": "An activity that adds information from the AWS IoT Device Shadow service to a message.
",
+ "base": "An activity that adds information from the IoT Device Shadow service to a message.
",
"refs": {
- "PipelineActivity$deviceShadowEnrich": "Adds information from the AWS IoT Device Shadow service to a message.
"
+ "PipelineActivity$deviceShadowEnrich": "Adds information from the IoT Device Shadow service to a message.
"
}
},
"DoubleValue": {
@@ -715,7 +729,7 @@
"base": null,
"refs": {
"DatasetContentDeliveryRule$entryName": "The name of the dataset content delivery rules entry.
",
- "DatasetEntry$entryName": "The name of the data set item.
"
+ "DatasetEntry$entryName": "The name of the dataset item.
"
}
},
"ErrorCode": {
@@ -738,11 +752,11 @@
}
},
"FileFormatConfiguration": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "CreateDatastoreRequest$fileFormatConfiguration": "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.
",
- "Datastore$fileFormatConfiguration": "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.
",
- "UpdateDatastoreRequest$fileFormatConfiguration": "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.
"
+ "CreateDatastoreRequest$fileFormatConfiguration": "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.
",
+ "Datastore$fileFormatConfiguration": "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.
",
+ "UpdateDatastoreRequest$fileFormatConfiguration": "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": {
@@ -774,21 +788,21 @@
}
},
"GlueConfiguration": {
- "base": "Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.
",
+ "base": "Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
",
"refs": {
- "S3DestinationConfiguration$glueConfiguration": "Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.
"
+ "S3DestinationConfiguration$glueConfiguration": "Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
"
}
},
"GlueDatabaseName": {
"base": null,
"refs": {
- "GlueConfiguration$databaseName": "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.
"
+ "GlueConfiguration$databaseName": "The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.
"
}
},
"GlueTableName": {
"base": null,
"refs": {
- "GlueConfiguration$tableName": "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.
"
+ "GlueConfiguration$tableName": "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.
"
}
},
"Image": {
@@ -800,8 +814,8 @@
"IncludeStatisticsFlag": {
"base": null,
"refs": {
- "DescribeChannelRequest$includeStatistics": "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.
",
- "DescribeDatastoreRequest$includeStatistics": "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.
"
+ "DescribeChannelRequest$includeStatistics": "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.
",
+ "DescribeDatastoreRequest$includeStatistics": "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.
"
}
},
"InternalFailureException": {
@@ -815,15 +829,27 @@
}
},
"IotEventsDestinationConfiguration": {
- "base": "Configuration information for delivery of dataset contents to AWS IoT Events.
",
+ "base": "Configuration information for delivery of dataset contents to IoT Events.
",
"refs": {
- "DatasetContentDeliveryDestination$iotEventsDestinationConfiguration": "Configuration information for delivery of dataset contents to AWS IoT Events.
"
+ "DatasetContentDeliveryDestination$iotEventsDestinationConfiguration": "Configuration information for delivery of dataset contents to IoT Events.
"
}
},
"IotEventsInputName": {
"base": null,
"refs": {
- "IotEventsDestinationConfiguration$inputName": "The name of the AWS IoT Events input to which dataset contents are delivered.
"
+ "IotEventsDestinationConfiguration$inputName": "The name of the IoT Events input to which dataset contents are delivered.
"
+ }
+ },
+ "IotSiteWiseCustomerManagedDatastoreS3Storage": {
+ "base": " 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.
",
+ "refs": {
+ "DatastoreIotSiteWiseMultiLayerStorage$customerManagedS3Storage": " Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
"
+ }
+ },
+ "IotSiteWiseCustomerManagedDatastoreS3StorageSummary": {
+ "base": " Contains information about the data store that you manage, which stores data used by IoT SiteWise.
",
+ "refs": {
+ "DatastoreIotSiteWiseMultiLayerStorageSummary$customerManagedS3Storage": "Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
"
}
},
"JsonConfiguration": {
@@ -865,9 +891,9 @@
"LateDataRules": {
"base": null,
"refs": {
- "CreateDatasetRequest$lateDataRules": "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.
",
- "Dataset$lateDataRules": "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.
",
- "UpdateDatasetRequest$lateDataRules": "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.
"
+ "CreateDatasetRequest$lateDataRules": "A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
",
+ "Dataset$lateDataRules": "A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
",
+ "UpdateDatasetRequest$lateDataRules": "A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
"
}
},
"LimitExceededException": {
@@ -944,7 +970,7 @@
"LoggingEnabled": {
"base": null,
"refs": {
- "LoggingOptions$enabled": "If true, logging is enabled for AWS IoT Analytics.
"
+ "LoggingOptions$enabled": "If true, logging is enabled for IoT Analytics.
"
}
},
"LoggingLevel": {
@@ -956,8 +982,8 @@
"LoggingOptions": {
"base": "Information about logging options.
",
"refs": {
- "DescribeLoggingOptionsResponse$loggingOptions": "The current settings of the AWS IoT Analytics logging options.
",
- "PutLoggingOptionsRequest$loggingOptions": "The new values of the AWS IoT Analytics logging options.
"
+ "DescribeLoggingOptionsResponse$loggingOptions": "The current settings of the IoT Analytics logging options.
",
+ "PutLoggingOptionsRequest$loggingOptions": "The new values of the IoT Analytics logging options.
"
}
},
"MathActivity": {
@@ -1025,7 +1051,7 @@
"Messages": {
"base": null,
"refs": {
- "BatchPutMessageRequest$messages": "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.
"
+ "BatchPutMessageRequest$messages": "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.
"
}
},
"NextToken": {
@@ -1068,22 +1094,22 @@
}
},
"Partition": {
- "base": " A single partition.
",
+ "base": " A partition dimension defined by an attribute.
",
"refs": {
- "DatastorePartition$attributePartition": " A partition defined by an attributeName.
"
+ "DatastorePartition$attributePartition": " A partition dimension defined by an attributeName.
"
}
},
"PartitionAttributeName": {
"base": null,
"refs": {
- "Partition$attributeName": " The attribute name of the partition.
",
+ "Partition$attributeName": " The name of the attribute that defines a partition dimension.
",
"TimestampPartition$attributeName": " The attribute name of the partition defined by a timestamp.
"
}
},
"Partitions": {
"base": null,
"refs": {
- "DatastorePartitions$partitions": " A list of partitions in a data store.
"
+ "DatastorePartitions$partitions": " A list of partition dimensions in a data store.
"
}
},
"Pipeline": {
@@ -1095,7 +1121,7 @@
"PipelineActivities": {
"base": null,
"refs": {
- "CreatePipelineRequest$pipelineActivities": "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\": { ... } }, ... ]
",
+ "CreatePipelineRequest$pipelineActivities": "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\": { ... } }, ... ]
",
"Pipeline$activities": "The activities that perform transformations on the messages.
",
"UpdatePipelineRequest$pipelineActivities": "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\": { ... } }, ... ]
"
}
@@ -1104,7 +1130,7 @@
"base": "An activity that performs a transformation on a message.
",
"refs": {
"PipelineActivities$member": null,
- "RunPipelineActivityRequest$pipelineActivity": "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.
"
+ "RunPipelineActivityRequest$pipelineActivity": "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.
"
}
},
"PipelineArn": {
@@ -1143,7 +1169,7 @@
"PresignedURI": {
"base": null,
"refs": {
- "DatasetEntry$dataURI": "The presigned URI of the data set item.
"
+ "DatasetEntry$dataURI": "The presigned URI of the dataset item.
"
}
},
"PutLoggingOptionsRequest": {
@@ -1166,7 +1192,7 @@
"Reason": {
"base": null,
"refs": {
- "DatasetContentStatus$reason": "The reason the data set contents are in this state.
"
+ "DatasetContentStatus$reason": "The reason the dataset contents are in this state.
"
}
},
"RemoveAttributesActivity": {
@@ -1232,15 +1258,15 @@
"Channel$retentionPeriod": "How long, in days, message data is kept for the channel.
",
"CreateChannelRequest$retentionPeriod": "How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.
",
"CreateChannelResponse$retentionPeriod": "How long, in days, message data is kept for the channel.
",
- "CreateDatasetRequest$retentionPeriod": "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.
",
+ "CreateDatasetRequest$retentionPeriod": "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.
",
"CreateDatasetResponse$retentionPeriod": "How long, in days, dataset contents are kept for the dataset.
",
"CreateDatastoreRequest$retentionPeriod": "How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
",
"CreateDatastoreResponse$retentionPeriod": "How long, in days, message data is kept for the data store.
",
- "Dataset$retentionPeriod": "Optional. How long, in days, message data is kept for the data set.
",
+ "Dataset$retentionPeriod": "Optional. How long, in days, message data is kept for the dataset.
",
"Datastore$retentionPeriod": "How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
",
- "UpdateChannelRequest$retentionPeriod": "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.
",
+ "UpdateChannelRequest$retentionPeriod": "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.
",
"UpdateDatasetRequest$retentionPeriod": "How long, in days, dataset contents are kept for the dataset.
",
- "UpdateDatastoreRequest$retentionPeriod": "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.
"
+ "UpdateDatastoreRequest$retentionPeriod": "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.
"
}
},
"RetentionPeriodInDays": {
@@ -1253,15 +1279,15 @@
"base": null,
"refs": {
"ContainerDatasetAction$executionRoleArn": "The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.
",
- "CustomerManagedChannelS3Storage$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
",
- "CustomerManagedChannelS3StorageSummary$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
",
- "CustomerManagedDatastoreS3Storage$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
",
- "CustomerManagedDatastoreS3StorageSummary$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
",
+ "CustomerManagedChannelS3Storage$roleArn": "The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
",
+ "CustomerManagedChannelS3StorageSummary$roleArn": "The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
",
+ "CustomerManagedDatastoreS3Storage$roleArn": "The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
",
+ "CustomerManagedDatastoreS3StorageSummary$roleArn": "The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
",
"DeviceRegistryEnrichActivity$roleArn": "The ARN of the role that allows access to the device's registry information.
",
"DeviceShadowEnrichActivity$roleArn": "The ARN of the role that allows access to the device's shadow.
",
- "IotEventsDestinationConfiguration$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
",
- "LoggingOptions$roleArn": "The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
",
- "S3DestinationConfiguration$roleArn": "The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
"
+ "IotEventsDestinationConfiguration$roleArn": "The ARN of the role that grants IoT Analytics permission to deliver dataset contents to an IoT Events input.
",
+ "LoggingOptions$roleArn": "The ARN of the role that grants permission to IoT Analytics to perform logging.
",
+ "S3DestinationConfiguration$roleArn": "The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
"
}
},
"RunPipelineActivityRequest": {
@@ -1283,10 +1309,12 @@
"S3KeyPrefix": {
"base": null,
"refs": {
- "CustomerManagedChannelS3Storage$keyPrefix": "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 (/).
",
- "CustomerManagedChannelS3StorageSummary$keyPrefix": "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 (/).
",
- "CustomerManagedDatastoreS3Storage$keyPrefix": "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 (/).
",
- "CustomerManagedDatastoreS3StorageSummary$keyPrefix": "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 (/).
"
+ "CustomerManagedChannelS3Storage$keyPrefix": "(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 (/).
",
+ "CustomerManagedChannelS3StorageSummary$keyPrefix": "(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 (/).
",
+ "CustomerManagedDatastoreS3Storage$keyPrefix": "(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 (/).
",
+ "CustomerManagedDatastoreS3StorageSummary$keyPrefix": "(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 (/).
",
+ "IotSiteWiseCustomerManagedDatastoreS3Storage$keyPrefix": " (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 (/).
",
+ "IotSiteWiseCustomerManagedDatastoreS3StorageSummary$keyPrefix": " (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 (/).
"
}
},
"S3PathChannelMessage": {
@@ -1330,33 +1358,33 @@
}
},
"SelectAttributesActivity": {
- "base": "Creates a new message using only the specified attributes from the original message.
",
+ "base": "Used to create a new message using only the specified attributes from the original message.
",
"refs": {
- "PipelineActivity$selectAttributes": "Creates a new message using only the specified attributes from the original message.
"
+ "PipelineActivity$selectAttributes": "Used to create a new message using only the specified attributes from the original message.
"
}
},
"ServiceManagedChannelS3Storage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "ChannelStorage$serviceManagedS3": "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.
"
+ "ChannelStorage$serviceManagedS3": "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": {
- "base": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
",
+ "base": "Used to store channel data in an S3 bucket managed by IoT Analytics.
",
"refs": {
- "ChannelStorageSummary$serviceManagedS3": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
"
+ "ChannelStorageSummary$serviceManagedS3": "Used to store channel data in an S3 bucket managed by IoT Analytics.
"
}
},
"ServiceManagedDatastoreS3Storage": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "DatastoreStorage$serviceManagedS3": "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.
"
+ "DatastoreStorage$serviceManagedS3": "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": {
- "base": "Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
",
+ "base": "Contains information about the data store that is managed by IoT Analytics.
",
"refs": {
- "DatastoreStorageSummary$serviceManagedS3": "Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
"
+ "DatastoreStorageSummary$serviceManagedS3": "Used to store data in an Amazon S3 bucket managed by IoT Analytics.
"
}
},
"ServiceUnavailableException": {
@@ -1367,7 +1395,7 @@
"SessionTimeoutInMinutes": {
"base": null,
"refs": {
- "DeltaTimeSessionWindowConfiguration$timeoutInMinutes": "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.
"
+ "DeltaTimeSessionWindowConfiguration$timeoutInMinutes": "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.
"
}
},
"SizeInBytes": {
@@ -1385,7 +1413,7 @@
"SqlQueryDatasetAction": {
"base": "The SQL query to modify the message.
",
"refs": {
- "DatasetAction$queryAction": "An SqlQueryDatasetAction object that uses an SQL query to automatically create data set contents.
"
+ "DatasetAction$queryAction": "An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.
"
}
},
"StartPipelineReprocessingRequest": {
@@ -1434,7 +1462,7 @@
"base": null,
"refs": {
"CreateChannelRequest$tags": "Metadata which can be used to manage the channel.
",
- "CreateDatasetRequest$tags": "Metadata which can be used to manage the data set.
",
+ "CreateDatasetRequest$tags": "Metadata which can be used to manage the dataset.
",
"CreateDatastoreRequest$tags": "Metadata which can be used to manage the data store.
",
"CreatePipelineRequest$tags": "Metadata which can be used to manage the pipeline.
",
"ListTagsForResourceResponse$tags": "The tags (metadata) that you have assigned to the resource.
",
@@ -1473,27 +1501,27 @@
"refs": {
"Channel$creationTime": "When the channel was created.
",
"Channel$lastUpdateTime": "When the channel was last updated.
",
- "Channel$lastMessageArrivalTime": "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.
",
+ "Channel$lastMessageArrivalTime": "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.
",
"ChannelSummary$creationTime": "When the channel was created.
",
"ChannelSummary$lastUpdateTime": "The last time the channel was updated.
",
- "ChannelSummary$lastMessageArrivalTime": "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.
",
- "Dataset$creationTime": "When the data set was created.
",
- "Dataset$lastUpdateTime": "The last time the data set was updated.
",
+ "ChannelSummary$lastMessageArrivalTime": "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.
",
+ "Dataset$creationTime": "When the dataset was created.
",
+ "Dataset$lastUpdateTime": "The last time the dataset was updated.
",
"DatasetContentSummary$creationTime": "The actual time the creation of the dataset contents was started.
",
"DatasetContentSummary$scheduleTime": "The time the creation of the dataset contents was scheduled to start.
",
"DatasetContentSummary$completionTime": "The time the dataset content status was updated to SUCCEEDED or FAILED.
",
- "DatasetSummary$creationTime": "The time the data set was created.
",
- "DatasetSummary$lastUpdateTime": "The last time the data set was updated.
",
+ "DatasetSummary$creationTime": "The time the dataset was created.
",
+ "DatasetSummary$lastUpdateTime": "The last time the dataset was updated.
",
"Datastore$creationTime": "When the data store was created.
",
"Datastore$lastUpdateTime": "The last time the data store was updated.
",
- "Datastore$lastMessageArrivalTime": "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.
",
+ "Datastore$lastMessageArrivalTime": "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.
",
"DatastoreSummary$creationTime": "When the data store was created.
",
"DatastoreSummary$lastUpdateTime": "The last time the data store was updated.
",
- "DatastoreSummary$lastMessageArrivalTime": "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.
",
+ "DatastoreSummary$lastMessageArrivalTime": "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.
",
"EstimatedResourceSize$estimatedOn": "The time when the estimate of the size of the resource was made.
",
"GetDatasetContentResponse$timestamp": "The time when the request was made.
",
- "ListDatasetContentsRequest$scheduledOnOrAfter": "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)
",
- "ListDatasetContentsRequest$scheduledBefore": "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)
",
+ "ListDatasetContentsRequest$scheduledOnOrAfter": "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)
",
+ "ListDatasetContentsRequest$scheduledBefore": "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)
",
"Pipeline$creationTime": "When the pipeline was created.
",
"Pipeline$lastUpdateTime": "The last time the pipeline was updated.
",
"PipelineSummary$creationTime": "When the pipeline was created.
",
@@ -1504,19 +1532,19 @@
"TimestampFormat": {
"base": null,
"refs": {
- "TimestampPartition$timestampFormat": " The timestamp format of a partition defined by a timestamp.
"
+ "TimestampPartition$timestampFormat": " The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
"
}
},
"TimestampPartition": {
- "base": " A partition defined by a timestamp.
",
+ "base": " A partition dimension defined by a timestamp attribute.
",
"refs": {
- "DatastorePartition$timestampPartition": " A partition defined by an attributeName and a timestamp format.
"
+ "DatastorePartition$timestampPartition": " A partition dimension defined by a timestamp attribute.
"
}
},
"TriggeringDataset": {
"base": "Information about the dataset whose content generation triggers the new dataset content generation.
",
"refs": {
- "DatasetTrigger$dataset": "The data set whose content creation triggers the creation of this data set's contents.
"
+ "DatasetTrigger$dataset": "The dataset whose content creation triggers the creation of this dataset's contents.
"
}
},
"UnlimitedRetentionPeriod": {
@@ -1582,9 +1610,9 @@
"VersioningConfiguration": {
"base": "Information about the versioning of dataset contents.
",
"refs": {
- "CreateDatasetRequest$versioningConfiguration": "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.
",
- "Dataset$versioningConfiguration": "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.
",
- "UpdateDatasetRequest$versioningConfiguration": "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.
"
+ "CreateDatasetRequest$versioningConfiguration": "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.
",
+ "Dataset$versioningConfiguration": "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.
",
+ "UpdateDatasetRequest$versioningConfiguration": "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.
"
}
},
"VolumeSizeInGB": {
diff --git a/models/apis/iotwireless/2020-11-22/api-2.json b/models/apis/iotwireless/2020-11-22/api-2.json
index 1c76d692fa..4cc237494b 100644
--- a/models/apis/iotwireless/2020-11-22/api-2.json
+++ b/models/apis/iotwireless/2020-11-22/api-2.json
@@ -2705,6 +2705,7 @@
"SidewalkDevice":{
"type":"structure",
"members":{
+ "AmazonId":{"shape":"AmazonId"},
"SidewalkId":{"shape":"SidewalkId"},
"SidewalkManufacturingSn":{"shape":"SidewalkManufacturingSn"},
"DeviceCertificates":{"shape":"DeviceCertificateList"}
@@ -3081,7 +3082,8 @@
"enum":[
"WirelessDeviceId",
"DevEui",
- "ThingName"
+ "ThingName",
+ "SidewalkManufacturingSn"
]
},
"WirelessDeviceLogOption":{
diff --git a/models/apis/iotwireless/2020-11-22/docs-2.json b/models/apis/iotwireless/2020-11-22/docs-2.json
index 8485b56438..96c387df46 100644
--- a/models/apis/iotwireless/2020-11-22/docs-2.json
+++ b/models/apis/iotwireless/2020-11-22/docs-2.json
@@ -26,9 +26,9 @@
"DisassociateWirelessGatewayFromThing": "Disassociates a wireless gateway from its currently associated thing.
",
"GetDestination": "Gets information about a destination.
",
"GetDeviceProfile": "Gets information about a device profile.
",
- "GetLogLevelsByResourceTypes": "Returns current default log-levels, or log levels by resource types, could be for wireless device log options or wireless gateway log options.
",
+ "GetLogLevelsByResourceTypes": "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": "Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.
",
- "GetResourceLogLevel": "Fetches the log-level override if any for a given resource-ID and resource-type, coulde be a wireless device or a wireless gateway.
",
+ "GetResourceLogLevel": "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": "Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
",
"GetServiceProfile": "Gets information about a service profile.
",
"GetWirelessDevice": "Gets information about a wireless device.
",
@@ -47,15 +47,15 @@
"ListWirelessDevices": "Lists the wireless devices registered to your AWS account.
",
"ListWirelessGatewayTaskDefinitions": "List the wireless gateway tasks definitions registered to your AWS account.
",
"ListWirelessGateways": "Lists the wireless gateways registered to your AWS account.
",
- "PutResourceLogLevel": "Sets the log-level override for a resource-ID and resource-type, could be a wireless gateway or a wireless device.
",
- "ResetAllResourceLogLevels": "Remove log-level overrides if any for all resources (both wireless devices and wireless gateways).
",
- "ResetResourceLogLevel": "Remove log-level override if any for a specific resource-ID and resource-type, could be a wireless device or a wireless gateway.
",
+ "PutResourceLogLevel": "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": "Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
",
+ "ResetResourceLogLevel": "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": "Sends a decrypted application data frame to a device.
",
"TagResource": "Adds a tag to a resource.
",
"TestWirelessDevice": "Simulates a provisioned device by sending an uplink data payload of Hello.
",
"UntagResource": "Removes one or more tags from a resource.
",
"UpdateDestination": "Updates properties of a destination.
",
- "UpdateLogLevelsByResourceTypes": "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.
",
+ "UpdateLogLevelsByResourceTypes": "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": "Updates properties of a partner account.
",
"UpdateWirelessDevice": "Updates properties of a wireless device.
",
"UpdateWirelessGateway": "Updates properties of a wireless gateway.
"
@@ -92,10 +92,11 @@
}
},
"AmazonId": {
- "base": null,
+ "base": "The Sidewalk Amazon ID.
",
"refs": {
"SidewalkAccountInfo$AmazonId": "The Sidewalk Amazon ID.
",
"SidewalkAccountInfoWithFingerprint$AmazonId": "The Sidewalk Amazon ID.
",
+ "SidewalkDevice$AmazonId": null,
"SidewalkListDevice$AmazonId": "The Sidewalk Amazon ID.
"
}
},
@@ -1117,7 +1118,7 @@
}
},
"MessageType": {
- "base": "Sidewalk device message type.
",
+ "base": "Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.
",
"refs": {
"SidewalkSendDataToDevice$MessageType": null
}
@@ -1234,7 +1235,7 @@
"PayloadData": {
"base": null,
"refs": {
- "SendDataToWirelessDeviceRequest$PayloadData": "The message payload to send.
"
+ "SendDataToWirelessDeviceRequest$PayloadData": "The binary to be sent to the end device, encoded in base64.
"
}
},
"PingSlotDr": {
@@ -1329,7 +1330,7 @@
}
},
"ResourceIdentifier": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"GetResourceLogLevelRequest$ResourceIdentifier": null,
"PutResourceLogLevelRequest$ResourceIdentifier": null,
@@ -1345,9 +1346,9 @@
"base": null,
"refs": {
"ConflictException$ResourceType": "Type of the resource in the conflicting operation.
",
- "GetResourceLogLevelRequest$ResourceType": "The type of the resource, currently support WirelessDevice and WirelessGateway.
",
- "PutResourceLogLevelRequest$ResourceType": "The type of the resource, currently support WirelessDevice and WirelessGateway.
",
- "ResetResourceLogLevelRequest$ResourceType": "The type of the resource, currently support WirelessDevice and WirelessGateway.
",
+ "GetResourceLogLevelRequest$ResourceType": "The type of the resource, which can be WirelessDevice or WirelessGateway.
",
+ "PutResourceLogLevelRequest$ResourceType": "The type of the resource, which can be WirelessDevice or WirelessGateway.
",
+ "ResetResourceLogLevelRequest$ResourceType": "The type of the resource, which can be WirelessDevice or WirelessGateway.
",
"ResourceNotFoundException$ResourceType": "Type of the font found resource.
"
}
},
@@ -1805,7 +1806,7 @@
}
},
"WirelessDeviceEventLogOption": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"WirelessDeviceEventLogOptionList$member": null
}
@@ -1840,7 +1841,7 @@
}
},
"WirelessDeviceLogOption": {
- "base": "The log option for wireless devices. Can be used to set log level for a specific type of wireless device.
",
+ "base": "The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
",
"refs": {
"WirelessDeviceLogOptionList$member": null
}
@@ -1898,7 +1899,7 @@
}
},
"WirelessGatewayEventLogOption": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"WirelessGatewayEventLogOptionList$member": null
}
@@ -1937,7 +1938,7 @@
}
},
"WirelessGatewayLogOption": {
- "base": "The log option for wireless gateways. Can be used to set log level for a specific type of wireless gateway.
",
+ "base": "The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
",
"refs": {
"WirelessGatewayLogOptionList$member": null
}
diff --git a/models/apis/models.lex.v2/2020-08-07/waiters-2.json b/models/apis/models.lex.v2/2020-08-07/waiters-2.json
new file mode 100644
index 0000000000..1ec96048ec
--- /dev/null
+++ b/models/apis/models.lex.v2/2020-08-07/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"
+ }
+ ]
+ }
+ }
+}
+
diff --git a/models/apis/quicksight/2018-04-01/api-2.json b/models/apis/quicksight/2018-04-01/api-2.json
index b332dd6b7d..d3ae957ffd 100644
--- a/models/apis/quicksight/2018-04-01/api-2.json
+++ b/models/apis/quicksight/2018-04-01/api-2.json
@@ -1033,6 +1033,45 @@
{"shape":"ResourceUnavailableException"}
]
},
+ "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"}
+ ]
+ },
+ "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"}
+ ]
+ },
"GetDashboardEmbedUrl":{
"name":"GetDashboardEmbedUrl",
"http":{
@@ -2135,7 +2174,24 @@
"member":{"shape":"AnalysisSummary"},
"max":100
},
+ "AnonymousUserDashboardEmbeddingConfiguration":{
+ "type":"structure",
+ "required":["InitialDashboardId"],
+ "members":{
+ "InitialDashboardId":{"shape":"RestrictiveResourceId"}
+ }
+ },
+ "AnonymousUserEmbeddingExperienceConfiguration":{
+ "type":"structure",
+ "members":{
+ "Dashboard":{"shape":"AnonymousUserDashboardEmbeddingConfiguration"}
+ }
+ },
"Arn":{"type":"string"},
+ "ArnList":{
+ "type":"list",
+ "member":{"shape":"Arn"}
+ },
"AssignmentStatus":{
"type":"string",
"enum":[
@@ -2575,6 +2631,7 @@
"FieldFolders":{"shape":"FieldFolderMap"},
"Permissions":{"shape":"ResourcePermissionList"},
"RowLevelPermissionDataSet":{"shape":"RowLevelPermissionDataSet"},
+ "RowLevelPermissionTagConfiguration":{"shape":"RowLevelPermissionTagConfiguration"},
"ColumnLevelPermissionRules":{"shape":"ColumnLevelPermissionRuleList"},
"Tags":{"shape":"TagList"}
}
@@ -3254,6 +3311,7 @@
"ColumnGroups":{"shape":"ColumnGroupList"},
"FieldFolders":{"shape":"FieldFolderMap"},
"RowLevelPermissionDataSet":{"shape":"RowLevelPermissionDataSet"},
+ "RowLevelPermissionTagConfiguration":{"shape":"RowLevelPermissionTagConfiguration"},
"ColumnLevelPermissionRules":{"shape":"ColumnLevelPermissionRuleList"}
}
},
@@ -3319,6 +3377,7 @@
"LastUpdatedTime":{"shape":"Timestamp"},
"ImportMode":{"shape":"DataSetImportMode"},
"RowLevelPermissionDataSet":{"shape":"RowLevelPermissionDataSet"},
+ "RowLevelPermissionTagConfigurationApplied":{"shape":"Boolean"},
"ColumnLevelPermissionRulesApplied":{"shape":"Boolean"}
}
},
@@ -4907,6 +4966,11 @@
"type":"string",
"sensitive":true
},
+ "EntryPath":{
+ "type":"string",
+ "max":1000,
+ "min":1
+ },
"EntryPoint":{
"type":"string",
"max":1000,
@@ -5058,6 +5122,77 @@
"type":"string",
"enum":["SHARED"]
},
+ "GenerateEmbedUrlForAnonymousUserRequest":{
+ "type":"structure",
+ "required":[
+ "AwsAccountId",
+ "Namespace",
+ "AuthorizedResourceArns",
+ "ExperienceConfiguration"
+ ],
+ "members":{
+ "AwsAccountId":{
+ "shape":"AwsAccountId",
+ "location":"uri",
+ "locationName":"AwsAccountId"
+ },
+ "SessionLifetimeInMinutes":{"shape":"SessionLifetimeInMinutes"},
+ "Namespace":{"shape":"Namespace"},
+ "SessionTags":{"shape":"SessionTagList"},
+ "AuthorizedResourceArns":{"shape":"ArnList"},
+ "ExperienceConfiguration":{"shape":"AnonymousUserEmbeddingExperienceConfiguration"}
+ }
+ },
+ "GenerateEmbedUrlForAnonymousUserResponse":{
+ "type":"structure",
+ "required":[
+ "EmbedUrl",
+ "Status",
+ "RequestId"
+ ],
+ "members":{
+ "EmbedUrl":{"shape":"EmbeddingUrl"},
+ "Status":{
+ "shape":"StatusCode",
+ "location":"statusCode"
+ },
+ "RequestId":{"shape":"String"}
+ }
+ },
+ "GenerateEmbedUrlForRegisteredUserRequest":{
+ "type":"structure",
+ "required":[
+ "AwsAccountId",
+ "UserArn",
+ "ExperienceConfiguration"
+ ],
+ "members":{
+ "AwsAccountId":{
+ "shape":"AwsAccountId",
+ "location":"uri",
+ "locationName":"AwsAccountId"
+ },
+ "SessionLifetimeInMinutes":{"shape":"SessionLifetimeInMinutes"},
+ "UserArn":{"shape":"Arn"},
+ "ExperienceConfiguration":{"shape":"RegisteredUserEmbeddingExperienceConfiguration"}
+ }
+ },
+ "GenerateEmbedUrlForRegisteredUserResponse":{
+ "type":"structure",
+ "required":[
+ "EmbedUrl",
+ "Status",
+ "RequestId"
+ ],
+ "members":{
+ "EmbedUrl":{"shape":"EmbeddingUrl"},
+ "Status":{
+ "shape":"StatusCode",
+ "location":"statusCode"
+ },
+ "RequestId":{"shape":"String"}
+ }
+ },
"GeoSpatialColumnGroup":{
"type":"structure",
"required":[
@@ -6817,6 +6952,26 @@
}
}
},
+ "RegisteredUserDashboardEmbeddingConfiguration":{
+ "type":"structure",
+ "required":["InitialDashboardId"],
+ "members":{
+ "InitialDashboardId":{"shape":"RestrictiveResourceId"}
+ }
+ },
+ "RegisteredUserEmbeddingExperienceConfiguration":{
+ "type":"structure",
+ "members":{
+ "Dashboard":{"shape":"RegisteredUserDashboardEmbeddingConfiguration"},
+ "QuickSightConsole":{"shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration"}
+ }
+ },
+ "RegisteredUserQuickSightConsoleEmbeddingConfiguration":{
+ "type":"structure",
+ "members":{
+ "InitialPath":{"shape":"EntryPath"}
+ }
+ },
"RelationalTable":{
"type":"structure",
"required":[
@@ -6993,7 +7148,8 @@
"Namespace":{"shape":"Namespace"},
"Arn":{"shape":"Arn"},
"PermissionPolicy":{"shape":"RowLevelPermissionPolicy"},
- "FormatVersion":{"shape":"RowLevelPermissionFormatVersion"}
+ "FormatVersion":{"shape":"RowLevelPermissionFormatVersion"},
+ "Status":{"shape":"Status"}
}
},
"RowLevelPermissionFormatVersion":{
@@ -7010,6 +7166,37 @@
"DENY_ACCESS"
]
},
+ "RowLevelPermissionTagConfiguration":{
+ "type":"structure",
+ "required":["TagRules"],
+ "members":{
+ "Status":{"shape":"Status"},
+ "TagRules":{"shape":"RowLevelPermissionTagRuleList"}
+ }
+ },
+ "RowLevelPermissionTagDelimiter":{
+ "type":"string",
+ "max":10
+ },
+ "RowLevelPermissionTagRule":{
+ "type":"structure",
+ "required":[
+ "TagKey",
+ "ColumnName"
+ ],
+ "members":{
+ "TagKey":{"shape":"SessionTagKey"},
+ "ColumnName":{"shape":"String"},
+ "TagMultiValueDelimiter":{"shape":"RowLevelPermissionTagDelimiter"},
+ "MatchAllValue":{"shape":"SessionTagValue"}
+ }
+ },
+ "RowLevelPermissionTagRuleList":{
+ "type":"list",
+ "member":{"shape":"RowLevelPermissionTagRule"},
+ "max":50,
+ "min":1
+ },
"S3Bucket":{
"type":"string",
"max":1024,
@@ -7156,6 +7343,34 @@
"error":{"httpStatusCode":400},
"exception":true
},
+ "SessionTag":{
+ "type":"structure",
+ "required":[
+ "Key",
+ "Value"
+ ],
+ "members":{
+ "Key":{"shape":"SessionTagKey"},
+ "Value":{"shape":"SessionTagValue"}
+ }
+ },
+ "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":{
@@ -7234,6 +7449,13 @@
"DisableSsl":{"shape":"Boolean"}
}
},
+ "Status":{
+ "type":"string",
+ "enum":[
+ "ENABLED",
+ "DISABLED"
+ ]
+ },
"StatusCode":{"type":"integer"},
"String":{"type":"string"},
"StringList":{
@@ -7999,6 +8221,7 @@
"ColumnGroups":{"shape":"ColumnGroupList"},
"FieldFolders":{"shape":"FieldFolderMap"},
"RowLevelPermissionDataSet":{"shape":"RowLevelPermissionDataSet"},
+ "RowLevelPermissionTagConfiguration":{"shape":"RowLevelPermissionTagConfiguration"},
"ColumnLevelPermissionRules":{"shape":"ColumnLevelPermissionRuleList"}
}
},
diff --git a/models/apis/quicksight/2018-04-01/docs-2.json b/models/apis/quicksight/2018-04-01/docs-2.json
index f0b503bf18..2a8890fa66 100644
--- a/models/apis/quicksight/2018-04-01/docs-2.json
+++ b/models/apis/quicksight/2018-04-01/docs-2.json
@@ -1,25 +1,25 @@
{
"version": "2.0",
- "service": "Amazon QuickSight API Reference 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.
",
+ "service": "Amazon QuickSight API Reference 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.
",
"operations": {
"CancelIngestion": "Cancels an ongoing ingestion of data into SPICE.
",
- "CreateAccountCustomization": "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.
",
+ "CreateAccountCustomization": "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.
",
"CreateAnalysis": "Creates an analysis in Amazon QuickSight.
",
- "CreateDashboard": "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.
",
+ "CreateDashboard": "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": "Creates a dataset.
",
"CreateDataSource": "Creates a data source.
",
"CreateFolder": "Creates an empty shared folder.
",
"CreateFolderMembership": "Adds an asset, such as a dashboard, analysis, or dataset into a folder.
",
"CreateGroup": "Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
",
"CreateGroupMembership": "Adds an Amazon QuickSight user to an Amazon QuickSight group.
",
- "CreateIAMPolicyAssignment": "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.
",
- "CreateIngestion": "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.
",
- "CreateNamespace": "(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.
",
- "CreateTemplate": "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.
",
+ "CreateIAMPolicyAssignment": "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": "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": "(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": "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": "Creates a template alias for a template.
",
"CreateTheme": "Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
",
"CreateThemeAlias": "Creates a theme alias for a theme.
",
- "DeleteAccountCustomization": "Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
",
+ "DeleteAccountCustomization": "Deletes all Amazon QuickSight customizations in this Region; for the specified Amazon Web Services account; and QuickSight namespace.
",
"DeleteAnalysis": "Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
",
"DeleteDashboard": "Deletes a dashboard.
",
"DeleteDataSet": "Deletes a dataset.
",
@@ -34,10 +34,10 @@
"DeleteTemplateAlias": "Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
",
"DeleteTheme": "Deletes a theme.
",
"DeleteThemeAlias": "Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
",
- "DeleteUser": "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.
",
+ "DeleteUser": "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": "Deletes a user identified by its principal ID.
",
- "DescribeAccountCustomization": "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:
-
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.
",
- "DescribeAccountSettings": "Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
",
+ "DescribeAccountCustomization": "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:
-
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.
",
+ "DescribeAccountSettings": "Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account;.
",
"DescribeAnalysis": "Provides a summary of the metadata for an analysis.
",
"DescribeAnalysisPermissions": "Provides the read and write permissions for an analysis.
",
"DescribeDashboard": "Provides a summary for a dashboard.
",
@@ -60,13 +60,15 @@
"DescribeThemeAlias": "Describes the alias for a theme.
",
"DescribeThemePermissions": "Describes the read and write permissions for a theme.
",
"DescribeUser": "Returns information about a user, given the user name.
",
- "GetDashboardEmbedUrl": "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.
",
+ "GenerateEmbedUrlForAnonymousUser": "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": "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": "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": "Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need 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:
",
- "ListAnalyses": "Lists Amazon QuickSight analyses that exist in the specified AWS account.
",
+ "ListAnalyses": "Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account;.
",
"ListDashboardVersions": "Lists all the versions of the dashboards in the QuickSight subscription.
",
- "ListDashboards": "Lists dashboards in an AWS account.
",
- "ListDataSets": "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/*.
",
- "ListDataSources": "Lists data sources in current AWS Region that belong to this AWS account.
",
+ "ListDashboards": "Lists dashboards in an Amazon Web Services account;.
",
+ "ListDataSets": "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/*.
",
+ "ListDataSources": "Lists data sources in current Region; that belong to this Amazon Web Services account;.
",
"ListFolderMembers": "List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
",
"ListFolders": "Lists all folders in an account.
",
"ListGroupMemberships": "Lists member users in a group.
",
@@ -74,28 +76,28 @@
"ListIAMPolicyAssignments": "Lists IAM policy assignments in the current Amazon QuickSight account.
",
"ListIAMPolicyAssignmentsForUser": "Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
",
"ListIngestions": "Lists the history of SPICE ingestions for a dataset.
",
- "ListNamespaces": "Lists the namespaces for the specified AWS account.
",
+ "ListNamespaces": "Lists the namespaces for the specified Amazon Web Services account;.
",
"ListTagsForResource": "Lists the tags assigned to a resource.
",
"ListTemplateAliases": "Lists all the aliases of a template.
",
"ListTemplateVersions": "Lists all the versions of the templates in the current Amazon QuickSight account.
",
"ListTemplates": "Lists all the templates in the current Amazon QuickSight account.
",
"ListThemeAliases": "Lists all the aliases of a theme.
",
- "ListThemeVersions": "Lists all the versions of the themes in the current AWS account.
",
- "ListThemes": "Lists all the themes in the current AWS account.
",
+ "ListThemeVersions": "Lists all the versions of the themes in the current Amazon Web Services account;.
",
+ "ListThemes": "Lists all the themes in the current Amazon Web Services account;.
",
"ListUserGroups": "Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
",
"ListUsers": "Returns a list of all of the Amazon QuickSight users belonging to this account.
",
"RegisterUser": "Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
",
"RestoreAnalysis": "Restores an analysis.
",
- "SearchAnalyses": "Searches for analyses that belong to the user specified in the filter.
",
- "SearchDashboards": "Searches for dashboards that belong to a user.
",
+ "SearchAnalyses": "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.
",
+ "SearchDashboards": "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.
",
"SearchFolders": "Searches the subfolders in a folder.
",
- "TagResource": "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.
",
+ "TagResource": "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.
",
"UntagResource": "Removes a tag or tags from a resource.
",
- "UpdateAccountCustomization": "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.
",
- "UpdateAccountSettings": "Updates the Amazon QuickSight settings in your AWS account.
",
+ "UpdateAccountCustomization": "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.
",
+ "UpdateAccountSettings": "Updates the Amazon QuickSight settings in your Amazon Web Services account;.
",
"UpdateAnalysis": "Updates an analysis in Amazon QuickSight
",
"UpdateAnalysisPermissions": "Updates the read and write permissions for an analysis.
",
- "UpdateDashboard": "Updates a dashboard in an AWS account.
",
+ "UpdateDashboard": "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.
",
"UpdateDashboardPermissions": "Updates read and write permissions on a dashboard.
",
"UpdateDashboardPublishedVersion": "Updates the published version of a dashboard.
",
"UpdateDataSet": "Updates a dataset.
",
@@ -121,19 +123,19 @@
}
},
"AccountCustomization": {
- "base": "The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
",
+ "base": "The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Region;.
",
"refs": {
- "CreateAccountCustomizationRequest$AccountCustomization": "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\" }.
",
- "CreateAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations you're adding in the current AWS Region.
",
- "DescribeAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations that exist in the current AWS Region.
",
- "UpdateAccountCustomizationRequest$AccountCustomization": "The QuickSight customizations you're updating in the current AWS Region.
",
- "UpdateAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations you're updating in the current AWS Region.
"
+ "CreateAccountCustomizationRequest$AccountCustomization": "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\" }.
",
+ "CreateAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations you're adding in the current Region;.
",
+ "DescribeAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations that exist in the current Region;.
",
+ "UpdateAccountCustomizationRequest$AccountCustomization": "The QuickSight customizations you're updating in the current Region;.
",
+ "UpdateAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations you're updating in the current Region;.
"
}
},
"AccountSettings": {
- "base": "The QuickSight settings associated with your AWS account.
",
+ "base": "The QuickSight settings associated with your Amazon Web Services account;.
",
"refs": {
- "DescribeAccountSettingsResponse$AccountSettings": "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.
"
+ "DescribeAccountSettingsResponse$AccountSettings": "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.
"
}
},
"ActionList": {
@@ -143,7 +145,7 @@
}
},
"ActiveIAMPolicyAssignment": {
- "base": "The active AWS Identity and Access Management (IAM) policy assignment.
",
+ "base": "The active Identity and Access Management (IAM) policy assignment.
",
"refs": {
"ActiveIAMPolicyAssignmentList$member": null
}
@@ -169,7 +171,7 @@
"AliasName": {
"base": null,
"refs": {
- "CreateTemplateAliasRequest$AliasName": "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.
",
+ "CreateTemplateAliasRequest$AliasName": "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.
",
"CreateThemeAliasRequest$AliasName": "The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.
",
"DeleteTemplateAliasRequest$AliasName": "The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.
",
"DeleteTemplateAliasResponse$AliasName": "The name for the template alias.
",
@@ -226,7 +228,7 @@
"base": null,
"refs": {
"Analysis$Name": "The descriptive name of the analysis.
",
- "AnalysisSummary$Name": "The name of the analysis. This name is displayed in the QuickSight console.
",
+ "AnalysisSummary$Name": "The name of the analysis. This name is displayed in the QuickSight console.
",
"CreateAnalysisRequest$Name": "A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
",
"UpdateAnalysisRequest$Name": "A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
"
}
@@ -269,6 +271,18 @@
"SearchAnalysesResponse$AnalysisSummaryList": "Metadata describing the analyses that you searched for.
"
}
},
+ "AnonymousUserDashboardEmbeddingConfiguration": {
+ "base": "Information about the dashboard that you want to embed.
",
+ "refs": {
+ "AnonymousUserEmbeddingExperienceConfiguration$Dashboard": "The type of embedding experience. In this case, an Amazon QuickSight dashboard.
"
+ }
+ },
+ "AnonymousUserEmbeddingExperienceConfiguration": {
+ "base": "The type of experience you want to embed. For anonymous users, you can embed an Amazon QuickSight dashboard.
",
+ "refs": {
+ "GenerateEmbedUrlForAnonymousUserRequest$ExperienceConfiguration": "The configuration of the experience you are embedding.
"
+ }
+ },
"Arn": {
"base": null,
"refs": {
@@ -278,11 +292,12 @@
"Analysis$ThemeArn": "The ARN of the theme of the analysis.
",
"AnalysisSourceTemplate$Arn": "The Amazon Resource Name (ARN) of the source template of an analysis.
",
"AnalysisSummary$Arn": "The Amazon Resource Name (ARN) for the analysis.
",
+ "ArnList$member": null,
"CancelIngestionResponse$Arn": "The Amazon Resource Name (ARN) for the data ingestion.
",
- "CreateAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
",
+ "CreateAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account;.
",
"CreateAnalysisRequest$ThemeArn": "The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
",
"CreateAnalysisResponse$Arn": "The ARN for the analysis.
",
- "CreateDashboardRequest$ThemeArn": "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.
",
+ "CreateDashboardRequest$ThemeArn": "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.
",
"CreateDashboardResponse$Arn": "The ARN of the dashboard.
",
"CreateDashboardResponse$VersionArn": "The ARN of the dashboard, including the version number of the first version that is created.
",
"CreateDataSetResponse$Arn": "The Amazon Resource Name (ARN) of the dataset.
",
@@ -321,7 +336,7 @@
"DeleteTemplateResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
",
"DeleteThemeAliasResponse$Arn": "The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
",
"DeleteThemeResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
",
- "DescribeAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
",
+ "DescribeAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account;.
",
"DescribeAnalysisPermissionsResponse$AnalysisArn": "The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
",
"DescribeDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
",
"DescribeDataSetPermissionsResponse$DataSetArn": "The Amazon Resource Name (ARN) of the dataset.
",
@@ -332,8 +347,9 @@
"DescribeThemePermissionsResponse$ThemeArn": "The Amazon Resource Name (ARN) of the theme.
",
"Folder$Arn": "The folder Amazon Resource Name (ARN).
",
"FolderSummary$Arn": "The Amazon Resource Name (ARN).
",
+ "GenerateEmbedUrlForRegisteredUserRequest$UserArn": "The Amazon Resource Name for the registered user.
",
"GetDashboardEmbedUrlRequest$UserArn": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
-
Active Directory (AD) users or group members
-
Invited nonfederated users
-
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.
",
- "GetSessionEmbedUrlRequest$UserArn": "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.
",
+ "GetSessionEmbedUrlRequest$UserArn": "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.
",
"Group$Arn": "The Amazon Resource Name (ARN) for the group.
",
"GroupMember$Arn": "The Amazon Resource Name (ARN) for the group member (user).
",
"IAMPolicyAssignment$PolicyArn": "The Amazon Resource Name (ARN) for the IAM policy.
",
@@ -361,13 +377,13 @@
"ThemeVersion$Arn": "The Amazon Resource Name (ARN) of the resource.
",
"ThemeVersionSummary$Arn": "The Amazon Resource Name (ARN) of the theme version.
",
"UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to untag.
",
- "UpdateAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) for the updated customization for this AWS account.
",
+ "UpdateAccountCustomizationResponse$Arn": "The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account;.
",
"UpdateAnalysisPermissionsResponse$AnalysisArn": "The Amazon Resource Name (ARN) of the analysis that you updated.
",
"UpdateAnalysisRequest$ThemeArn": "The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
",
"UpdateAnalysisResponse$Arn": "The ARN of the analysis that you're updating.
",
"UpdateDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
",
"UpdateDashboardPublishedVersionResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
",
- "UpdateDashboardRequest$ThemeArn": "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.
",
+ "UpdateDashboardRequest$ThemeArn": "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.
",
"UpdateDashboardResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
",
"UpdateDashboardResponse$VersionArn": "The ARN of the dashboard, including the version number.
",
"UpdateDataSetPermissionsResponse$DataSetArn": "The Amazon Resource Name (ARN) of the dataset.
",
@@ -389,6 +405,12 @@
"VpcConnectionProperties$VpcConnectionArn": "The Amazon Resource Name (ARN) for the VPC connection.
"
}
},
+ "ArnList": {
+ "base": null,
+ "refs": {
+ "GenerateEmbedUrlForAnonymousUserRequest$AuthorizedResourceArns": "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.
"
+ }
+ },
"AssignmentStatus": {
"base": null,
"refs": {
@@ -422,134 +444,137 @@
"AwsAccountId": {
"base": null,
"refs": {
- "CancelIngestionRequest$AwsAccountId": "The AWS account ID.
",
- "CreateAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to customize QuickSight for.
",
- "CreateAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to customize QuickSight for.
",
- "CreateAnalysisRequest$AwsAccountId": "The ID of the AWS account where you are creating an analysis.
",
- "CreateDashboardRequest$AwsAccountId": "The ID of the AWS account where you want to create the dashboard.
",
- "CreateDataSetRequest$AwsAccountId": "The AWS account ID.
",
- "CreateDataSourceRequest$AwsAccountId": "The AWS account ID.
",
+ "CancelIngestionRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "CreateAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to customize QuickSight for.
",
+ "CreateAccountCustomizationResponse$AwsAccountId": "The ID for the Amazon Web Services account; that you want to customize QuickSight for.
",
+ "CreateAnalysisRequest$AwsAccountId": "The ID of the Amazon Web Services account; where you are creating an analysis.
",
+ "CreateDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account; where you want to create the dashboard.
",
+ "CreateDataSetRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "CreateDataSourceRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
"CreateFolderMembershipRequest$AwsAccountId": "The AWS Account ID.
",
"CreateFolderRequest$AwsAccountId": "The AWS Account ID.
",
- "CreateGroupMembershipRequest$AwsAccountId": "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.
",
- "CreateGroupRequest$AwsAccountId": "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.
",
- "CreateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
",
- "CreateIngestionRequest$AwsAccountId": "The AWS account ID.
",
- "CreateNamespaceRequest$AwsAccountId": "The ID for the AWS account that you want to create the QuickSight namespace in.
",
- "CreateTemplateAliasRequest$AwsAccountId": "The ID of the AWS account that contains the template that you creating an alias for.
",
- "CreateTemplateRequest$AwsAccountId": "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.
",
- "CreateThemeAliasRequest$AwsAccountId": "The ID of the AWS account that contains the theme for the new theme alias.
",
- "CreateThemeRequest$AwsAccountId": "The ID of the AWS account where you want to store the new theme.
",
- "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.
",
- "DeleteAnalysisRequest$AwsAccountId": "The ID of the AWS account where you want to delete an analysis.
",
- "DeleteDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're deleting.
",
- "DeleteDataSetRequest$AwsAccountId": "The AWS account ID.
",
- "DeleteDataSourceRequest$AwsAccountId": "The AWS account ID.
",
+ "CreateGroupMembershipRequest$AwsAccountId": "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.
",
+ "CreateGroupRequest$AwsAccountId": "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.
",
+ "CreateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the Amazon Web Services account; where you want to assign an IAM policy to QuickSight users or groups.
",
+ "CreateIngestionRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "CreateNamespaceRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to create the QuickSight namespace in.
",
+ "CreateTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template that you creating an alias for.
",
+ "CreateTemplateRequest$AwsAccountId": "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.
",
+ "CreateThemeAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme for the new theme alias.
",
+ "CreateThemeRequest$AwsAccountId": "The ID of the Amazon Web Services account; where you want to store the new theme.
",
+ "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in this Region;.
",
+ "DeleteAnalysisRequest$AwsAccountId": "The ID of the Amazon Web Services account; where you want to delete an analysis.
",
+ "DeleteDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're deleting.
",
+ "DeleteDataSetRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "DeleteDataSourceRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
"DeleteFolderMembershipRequest$AwsAccountId": "The AWS Account ID.
",
"DeleteFolderRequest$AwsAccountId": "The AWS Account ID for the folder.
",
- "DeleteGroupMembershipRequest$AwsAccountId": "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.
",
- "DeleteGroupRequest$AwsAccountId": "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.
",
- "DeleteIAMPolicyAssignmentRequest$AwsAccountId": "The AWS account ID where you want to delete the IAM policy assignment.
",
- "DeleteNamespaceRequest$AwsAccountId": "The ID for the AWS account that you want to delete the QuickSight namespace from.
",
- "DeleteTemplateAliasRequest$AwsAccountId": "The ID of the AWS account that contains the item to delete.
",
- "DeleteTemplateRequest$AwsAccountId": "The ID of the AWS account that contains the template that you're deleting.
",
- "DeleteThemeAliasRequest$AwsAccountId": "The ID of the AWS account that contains the theme alias to delete.
",
- "DeleteThemeRequest$AwsAccountId": "The ID of the AWS account that contains the theme that you're deleting.
",
- "DeleteUserByPrincipalIdRequest$AwsAccountId": "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.
",
- "DeleteUserRequest$AwsAccountId": "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.
",
- "DescribeAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to describe QuickSight customizations for.
",
- "DescribeAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you're describing.
",
- "DescribeAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the settings that you want to list.
",
- "DescribeAnalysisPermissionsRequest$AwsAccountId": "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.
",
- "DescribeAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.
",
- "DescribeDashboardPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're describing permissions for.
",
- "DescribeDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're describing.
",
- "DescribeDataSetPermissionsRequest$AwsAccountId": "The AWS account ID.
",
- "DescribeDataSetRequest$AwsAccountId": "The AWS account ID.
",
- "DescribeDataSourcePermissionsRequest$AwsAccountId": "The AWS account ID.
",
- "DescribeDataSourceRequest$AwsAccountId": "The AWS account ID.
",
+ "DeleteGroupMembershipRequest$AwsAccountId": "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.
",
+ "DeleteGroupRequest$AwsAccountId": "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.
",
+ "DeleteIAMPolicyAssignmentRequest$AwsAccountId": "The Amazon Web Services account; ID where you want to delete the IAM policy assignment.
",
+ "DeleteNamespaceRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to delete the QuickSight namespace from.
",
+ "DeleteTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the item to delete.
",
+ "DeleteTemplateRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template that you're deleting.
",
+ "DeleteThemeAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme alias to delete.
",
+ "DeleteThemeRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme that you're deleting.
",
+ "DeleteUserByPrincipalIdRequest$AwsAccountId": "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.
",
+ "DeleteUserRequest$AwsAccountId": "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.
",
+ "DescribeAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to describe QuickSight customizations for.
",
+ "DescribeAccountCustomizationResponse$AwsAccountId": "The ID for the Amazon Web Services account; that you're describing.
",
+ "DescribeAccountSettingsRequest$AwsAccountId": "The ID for the Amazon Web Services account; that contains the settings that you want to list.
",
+ "DescribeAnalysisPermissionsRequest$AwsAccountId": "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.
",
+ "DescribeAnalysisRequest$AwsAccountId": "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.
",
+ "DescribeDashboardPermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're describing permissions for.
",
+ "DescribeDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're describing.
",
+ "DescribeDataSetPermissionsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "DescribeDataSetRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "DescribeDataSourcePermissionsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "DescribeDataSourceRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
"DescribeFolderPermissionsRequest$AwsAccountId": "The AWS Account ID.
",
"DescribeFolderRequest$AwsAccountId": "The AWS account ID.
",
"DescribeFolderResolvedPermissionsRequest$AwsAccountId": "The AWS account ID.
",
- "DescribeGroupRequest$AwsAccountId": "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.
",
- "DescribeIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account that contains the assignment that you want to describe.
",
- "DescribeIngestionRequest$AwsAccountId": "The AWS account ID.
",
- "DescribeNamespaceRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight namespace that you want to describe.
",
- "DescribeTemplateAliasRequest$AwsAccountId": "The ID of the AWS account that contains the template alias that you're describing.
",
- "DescribeTemplatePermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the template that you're describing.
",
- "DescribeTemplateRequest$AwsAccountId": "The ID of the AWS account that contains the template that you're describing.
",
- "DescribeThemeAliasRequest$AwsAccountId": "The ID of the AWS account that contains the theme alias that you're describing.
",
- "DescribeThemePermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the theme that you're describing.
",
- "DescribeUserRequest$AwsAccountId": "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.
",
- "GetDashboardEmbedUrlRequest$AwsAccountId": "The ID for the AWS account that contains the dashboard that you're embedding.
",
- "GetSessionEmbedUrlRequest$AwsAccountId": "The ID for the AWS account associated with your QuickSight subscription.
",
- "IAMPolicyAssignment$AwsAccountId": "The AWS account ID.
",
- "ListAnalysesRequest$AwsAccountId": "The ID of the AWS account that contains the analyses.
",
- "ListDashboardVersionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're listing versions for.
",
- "ListDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboards that you're listing.
",
- "ListDataSetsRequest$AwsAccountId": "The AWS account ID.
",
- "ListDataSourcesRequest$AwsAccountId": "The AWS account ID.
",
+ "DescribeGroupRequest$AwsAccountId": "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.
",
+ "DescribeIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the assignment that you want to describe.
",
+ "DescribeIngestionRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "DescribeNamespaceRequest$AwsAccountId": "The ID for the Amazon Web Services account; that contains the QuickSight namespace that you want to describe.
",
+ "DescribeTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template alias that you're describing.
",
+ "DescribeTemplatePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template that you're describing.
",
+ "DescribeTemplateRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template that you're describing.
",
+ "DescribeThemeAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme alias that you're describing.
",
+ "DescribeThemePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme that you're describing.
",
+ "DescribeUserRequest$AwsAccountId": "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.
",
+ "GenerateEmbedUrlForAnonymousUserRequest$AwsAccountId": "The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
",
+ "GenerateEmbedUrlForRegisteredUserRequest$AwsAccountId": "The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
",
+ "GetDashboardEmbedUrlRequest$AwsAccountId": "The ID for the Amazon Web Services account; that contains the dashboard that you're embedding.
",
+ "GetSessionEmbedUrlRequest$AwsAccountId": "The ID for the Amazon Web Services account; associated with your QuickSight subscription.
",
+ "IAMPolicyAssignment$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "ListAnalysesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the analyses.
",
+ "ListDashboardVersionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're listing versions for.
",
+ "ListDashboardsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboards that you're listing.
",
+ "ListDataSetsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "ListDataSourcesRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
"ListFolderMembersRequest$AwsAccountId": "The AWS account ID.
",
"ListFoldersRequest$AwsAccountId": "The AWS account ID.
",
- "ListGroupMembershipsRequest$AwsAccountId": "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.
",
- "ListGroupsRequest$AwsAccountId": "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.
",
- "ListIAMPolicyAssignmentsForUserRequest$AwsAccountId": "The ID of the AWS account that contains the assignments.
",
- "ListIAMPolicyAssignmentsRequest$AwsAccountId": "The ID of the AWS account that contains these IAM policy assignments.
",
- "ListIngestionsRequest$AwsAccountId": "The AWS account ID.
",
- "ListNamespacesRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight namespaces that you want to list.
",
- "ListTemplateAliasesRequest$AwsAccountId": "The ID of the AWS account that contains the template aliases that you're listing.
",
- "ListTemplateVersionsRequest$AwsAccountId": "The ID of the AWS account that contains the templates that you're listing.
",
- "ListTemplatesRequest$AwsAccountId": "The ID of the AWS account that contains the templates that you're listing.
",
- "ListThemeAliasesRequest$AwsAccountId": "The ID of the AWS account that contains the theme aliases that you're listing.
",
- "ListThemeVersionsRequest$AwsAccountId": "The ID of the AWS account that contains the themes that you're listing.
",
- "ListThemesRequest$AwsAccountId": "The ID of the AWS account that contains the themes that you're listing.
",
- "ListUserGroupsRequest$AwsAccountId": "The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
",
- "ListUsersRequest$AwsAccountId": "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.
",
- "RegisterUserRequest$AwsAccountId": "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.
",
- "RestoreAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis.
",
- "SearchAnalysesRequest$AwsAccountId": "The ID of the AWS account that contains the analyses that you're searching for.
",
- "SearchDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the user whose dashboards you're searching for.
",
+ "ListGroupMembershipsRequest$AwsAccountId": "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.
",
+ "ListGroupsRequest$AwsAccountId": "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.
",
+ "ListIAMPolicyAssignmentsForUserRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the assignments.
",
+ "ListIAMPolicyAssignmentsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains these IAM policy assignments.
",
+ "ListIngestionsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "ListNamespacesRequest$AwsAccountId": "The ID for the Amazon Web Services account; that contains the QuickSight namespaces that you want to list.
",
+ "ListTemplateAliasesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template aliases that you're listing.
",
+ "ListTemplateVersionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the templates that you're listing.
",
+ "ListTemplatesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the templates that you're listing.
",
+ "ListThemeAliasesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme aliases that you're listing.
",
+ "ListThemeVersionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the themes that you're listing.
",
+ "ListThemesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the themes that you're listing.
",
+ "ListUserGroupsRequest$AwsAccountId": "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.
",
+ "ListUsersRequest$AwsAccountId": "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.
",
+ "RegisterUserRequest$AwsAccountId": "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.
",
+ "RestoreAnalysisRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the analysis.
",
+ "SearchAnalysesRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the analyses that you're searching for.
",
+ "SearchDashboardsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the user whose dashboards you're searching for.
",
"SearchFoldersRequest$AwsAccountId": "The AWS account ID.
",
- "UpdateAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
",
- "UpdateAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
",
- "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight settings that you want to list.
",
- "UpdateAnalysisPermissionsRequest$AwsAccountId": "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.
",
- "UpdateAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis that you're updating.
",
- "UpdateDashboardPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard whose permissions you're updating.
",
- "UpdateDashboardPublishedVersionRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're updating.
",
- "UpdateDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're updating.
",
- "UpdateDataSetPermissionsRequest$AwsAccountId": "The AWS account ID.
",
- "UpdateDataSetRequest$AwsAccountId": "The AWS account ID.
",
- "UpdateDataSourcePermissionsRequest$AwsAccountId": "The AWS account ID.
",
- "UpdateDataSourceRequest$AwsAccountId": "The AWS account ID.
",
+ "UpdateAccountCustomizationRequest$AwsAccountId": "The ID for the Amazon Web Services account; that you want to update QuickSight customizations for.
",
+ "UpdateAccountCustomizationResponse$AwsAccountId": "The ID for the Amazon Web Services account; that you want to update QuickSight customizations for.
",
+ "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the Amazon Web Services account; that contains the QuickSight settings that you want to list.
",
+ "UpdateAnalysisPermissionsRequest$AwsAccountId": "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.
",
+ "UpdateAnalysisRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the analysis that you're updating.
",
+ "UpdateDashboardPermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard whose permissions you're updating.
",
+ "UpdateDashboardPublishedVersionRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're updating.
",
+ "UpdateDashboardRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the dashboard that you're updating.
",
+ "UpdateDataSetPermissionsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "UpdateDataSetRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "UpdateDataSourcePermissionsRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
+ "UpdateDataSourceRequest$AwsAccountId": "The Amazon Web Services account; ID.
",
"UpdateFolderPermissionsRequest$AwsAccountId": "The AWS account ID.
",
"UpdateFolderRequest$AwsAccountId": "The AWS account ID.
",
- "UpdateGroupRequest$AwsAccountId": "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.
",
- "UpdateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account that contains the IAM policy assignment.
",
- "UpdateTemplateAliasRequest$AwsAccountId": "The ID of the AWS account that contains the template alias that you're updating.
",
- "UpdateTemplatePermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the template.
",
- "UpdateTemplateRequest$AwsAccountId": "The ID of the AWS account that contains the template that you're updating.
",
- "UpdateThemeAliasRequest$AwsAccountId": "The ID of the AWS account that contains the theme alias that you're updating.
",
- "UpdateThemePermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the theme.
",
- "UpdateThemeRequest$AwsAccountId": "The ID of the AWS account that contains the theme that you're updating.
",
- "UpdateUserRequest$AwsAccountId": "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.
"
+ "UpdateGroupRequest$AwsAccountId": "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.
",
+ "UpdateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the IAM policy assignment.
",
+ "UpdateTemplateAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template alias that you're updating.
",
+ "UpdateTemplatePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template.
",
+ "UpdateTemplateRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the template that you're updating.
",
+ "UpdateThemeAliasRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme alias that you're updating.
",
+ "UpdateThemePermissionsRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme.
",
+ "UpdateThemeRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme that you're updating.
",
+ "UpdateUserRequest$AwsAccountId": "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.
"
}
},
"AwsAndAccountId": {
"base": null,
"refs": {
- "DescribeThemeRequest$AwsAccountId": "The ID of the AWS account that contains the theme that you're describing.
"
+ "DescribeThemeRequest$AwsAccountId": "The ID of the Amazon Web Services account; that contains the theme that you're describing.
"
}
},
"AwsIotAnalyticsParameters": {
- "base": "AWS IoT Analytics parameters.
",
+ "base": "Amazon Web Services IoT Analytics parameters.
",
"refs": {
- "DataSourceParameters$AwsIotAnalyticsParameters": "AWS IoT Analytics parameters.
"
+ "DataSourceParameters$AwsIotAnalyticsParameters": "Amazon Web Services IoT Analytics parameters.
"
}
},
"Boolean": {
"base": null,
"refs": {
+ "DataSetSummary$RowLevelPermissionTagConfigurationApplied": "Whether or not the row level permission tags are applied.
",
"DataSetSummary$ColumnLevelPermissionRulesApplied": "A value that indicates if the dataset has column level permission configured.
",
"GetDashboardEmbedUrlRequest$UndoRedoDisabled": "Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
",
"GetDashboardEmbedUrlRequest$ResetDisabled": "Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
",
@@ -744,7 +769,7 @@
"ColumnTagList": {
"base": null,
"refs": {
- "TagColumnOperation$Tags": "The dataset column tag, currently only used for geospatial type tagging. .
This is not tags for the AWS tagging feature. .
"
+ "TagColumnOperation$Tags": "The dataset column tag, currently only used for geospatial type tagging.
This is not tags for the Amazon Web Services tagging feature.
"
}
},
"ConcurrentUpdatingException": {
@@ -1015,8 +1040,8 @@
"DashboardSourceEntity": {
"base": "Dashboard source entity.
",
"refs": {
- "CreateDashboardRequest$SourceEntity": "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.
",
- "UpdateDashboardRequest$SourceEntity": "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.
"
+ "CreateDashboardRequest$SourceEntity": "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.
",
+ "UpdateDashboardRequest$SourceEntity": "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.
"
}
},
"DashboardSourceTemplate": {
@@ -1034,7 +1059,7 @@
"DashboardSummaryList": {
"base": null,
"refs": {
- "ListDashboardsResponse$DashboardSummaryList": "A structure that contains all of the dashboards in your AWS account. This structure provides basic information about the dashboards.
",
+ "ListDashboardsResponse$DashboardSummaryList": "A structure that contains all of the dashboards in your Amazon Web Services account;. This structure provides basic information about the dashboards.
",
"SearchDashboardsResponse$DashboardSummaryList": "The list of dashboards owned by the user specified in Filters in your request.
"
}
},
@@ -1689,10 +1714,18 @@
"EmbeddingUrl": {
"base": null,
"refs": {
+ "GenerateEmbedUrlForAnonymousUserResponse$EmbedUrl": "The embed URL for the dashboard.
",
+ "GenerateEmbedUrlForRegisteredUserResponse$EmbedUrl": "The embed URL for the Amazon QuickSight dashboard or console.
",
"GetDashboardEmbedUrlResponse$EmbedUrl": "A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
",
"GetSessionEmbedUrlResponse$EmbedUrl": "A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
"
}
},
+ "EntryPath": {
+ "base": null,
+ "refs": {
+ "RegisteredUserQuickSightConsoleEmbeddingConfiguration$InitialPath": "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.
"
+ }
+ },
"EntryPoint": {
"base": null,
"refs": {
@@ -1845,6 +1878,26 @@
"FolderSummary$FolderType": "The type of folder.
"
}
},
+ "GenerateEmbedUrlForAnonymousUserRequest": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "GenerateEmbedUrlForAnonymousUserResponse": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "GenerateEmbedUrlForRegisteredUserRequest": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "GenerateEmbedUrlForRegisteredUserResponse": {
+ "base": null,
+ "refs": {
+ }
+ },
"GeoSpatialColumnGroup": {
"base": "Geospatial column group that denotes a hierarchy.
",
"refs": {
@@ -1988,7 +2041,7 @@
}
},
"IAMPolicyAssignment": {
- "base": "An AWS Identity and Access Management (IAM) policy assignment.
",
+ "base": "An Identity and Access Management (IAM) policy assignment.
",
"refs": {
"DescribeIAMPolicyAssignmentResponse$IAMPolicyAssignment": "Information describing the IAM policy assignment.
"
}
@@ -1997,14 +2050,14 @@
"base": null,
"refs": {
"ActiveIAMPolicyAssignment$AssignmentName": "A name for the IAM policy assignment.
",
- "CreateIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment, also called a rule. It must be unique within an AWS account.
",
- "CreateIAMPolicyAssignmentResponse$AssignmentName": "The name of the assignment. This name must be unique within the AWS account.
",
+ "CreateIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account;.
",
+ "CreateIAMPolicyAssignmentResponse$AssignmentName": "The name of the assignment. This name must be unique within the Amazon Web Services account;.
",
"DeleteIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment.
",
"DeleteIAMPolicyAssignmentResponse$AssignmentName": "The name of the assignment.
",
"DescribeIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment, also called a rule.
",
"IAMPolicyAssignment$AssignmentName": "Assignment name.
",
"IAMPolicyAssignmentSummary$AssignmentName": "Assignment name.
",
- "UpdateIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment, also called a rule. This name must be unique within an AWS account.
",
+ "UpdateIAMPolicyAssignmentRequest$AssignmentName": "The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account;.
",
"UpdateIAMPolicyAssignmentResponse$AssignmentName": "The name of the assignment or rule.
"
}
},
@@ -2470,7 +2523,7 @@
"ManifestFileLocation": {
"base": "Amazon S3 manifest file location.
",
"refs": {
- "S3Parameters$ManifestFileLocation": "Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
"
+ "S3Parameters$ManifestFileLocation": "Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into QuickSight.
"
}
},
"MarginStyle": {
@@ -2536,7 +2589,7 @@
"Namespace": {
"base": null,
"refs": {
- "AccountSettings$DefaultNamespace": "The default QuickSight namespace for your AWS account.
",
+ "AccountSettings$DefaultNamespace": "The default QuickSight namespace for your Amazon Web Services account;.
",
"CreateAccountCustomizationRequest$Namespace": "The QuickSight namespace that you want to add customizations to.
",
"CreateAccountCustomizationResponse$Namespace": "The namespace associated with the customization you're creating.
",
"CreateGroupMembershipRequest$Namespace": "The namespace. Currently, you should set this to default.
",
@@ -2557,7 +2610,8 @@
"DescribeIAMPolicyAssignmentRequest$Namespace": "The namespace that contains the assignment.
",
"DescribeNamespaceRequest$Namespace": "The namespace that you want to describe.
",
"DescribeUserRequest$Namespace": "The namespace. Currently, you should set this to default.
",
- "GetDashboardEmbedUrlRequest$Namespace": "The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to \"default\".
",
+ "GenerateEmbedUrlForAnonymousUserRequest$Namespace": "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.
",
+ "GetDashboardEmbedUrlRequest$Namespace": "The Amazon QuickSight namespace that the user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
",
"ListGroupMembershipsRequest$Namespace": "The namespace. Currently, you should set this to default.
",
"ListGroupsRequest$Namespace": "The namespace. Currently, you should set this to default.
",
"ListIAMPolicyAssignmentsForUserRequest$Namespace": "The namespace of the assignment.
",
@@ -2569,7 +2623,7 @@
"RowLevelPermissionDataSet$Namespace": "The namespace associated with the dataset that contains permissions for RLS.
",
"UpdateAccountCustomizationRequest$Namespace": "The namespace that you want to update QuickSight customizations for.
",
"UpdateAccountCustomizationResponse$Namespace": "The namespace associated with the customization that you're updating.
",
- "UpdateAccountSettingsRequest$DefaultNamespace": "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.
",
+ "UpdateAccountSettingsRequest$DefaultNamespace": "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.
",
"UpdateGroupRequest$Namespace": "The namespace. Currently, you should set this to default.
",
"UpdateIAMPolicyAssignmentRequest$Namespace": "The namespace of the assignment.
",
"UpdateUserRequest$Namespace": "The namespace. Currently, you should set this to default.
"
@@ -2590,7 +2644,7 @@
"NamespaceInfoV2": {
"base": "The error type.
",
"refs": {
- "DescribeNamespaceResponse$Namespace": "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.
",
+ "DescribeNamespaceResponse$Namespace": "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.
",
"Namespaces$member": null
}
},
@@ -2604,7 +2658,7 @@
"Namespaces": {
"base": null,
"refs": {
- "ListNamespacesResponse$Namespaces": "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.
"
+ "ListNamespacesResponse$Namespaces": "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.
"
}
},
"NonEmptyString": {
@@ -2736,7 +2790,7 @@
"Principal": {
"base": null,
"refs": {
- "ResourcePermission$Principal": "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.)
"
+ "ResourcePermission$Principal": "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.)
"
}
},
"PrincipalList": {
@@ -2802,6 +2856,24 @@
"refs": {
}
},
+ "RegisteredUserDashboardEmbeddingConfiguration": {
+ "base": "Information about the dashboard you want to embed.
",
+ "refs": {
+ "RegisteredUserEmbeddingExperienceConfiguration$Dashboard": "The configuration details for providing a dashboard embedding experience.
"
+ }
+ },
+ "RegisteredUserEmbeddingExperienceConfiguration": {
+ "base": "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.
",
+ "refs": {
+ "GenerateEmbedUrlForRegisteredUserRequest$ExperienceConfiguration": "The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.
"
+ }
+ },
+ "RegisteredUserQuickSightConsoleEmbeddingConfiguration": {
+ "base": "Information about the Amazon QuickSight console that you want to embed.
",
+ "refs": {
+ "RegisteredUserEmbeddingExperienceConfiguration$QuickSightConsole": "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.
"
+ }
+ },
"RelationalTable": {
"base": "A physical table type for relational data sources.
",
"refs": {
@@ -2840,33 +2912,33 @@
"ResourceId": {
"base": null,
"refs": {
- "CreateDataSetRequest$DataSetId": "An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "CreateDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
+ "CreateDataSetRequest$DataSetId": "An ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "CreateDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
"CreateDataSetResponse$IngestionId": "The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
",
- "CreateDataSourceRequest$DataSourceId": "An ID for the data source. This ID is unique per AWS Region for each AWS account.
",
- "CreateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
+ "CreateDataSourceRequest$DataSourceId": "An ID for the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "CreateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
"DataSet$DataSetId": "The ID of the dataset.
",
"DataSetSummary$DataSetId": "The ID of the dataset.
",
- "DataSource$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "DeleteDataSetRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "DeleteDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "DeleteDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "DeleteDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSetPermissionsRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSetPermissionsResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSetRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "DescribeDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSetPermissionsRequest$DataSetId": "The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSetPermissionsResponse$DataSetId": "The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSetRequest$DataSetId": "The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
",
+ "DataSource$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DeleteDataSetRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DeleteDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DeleteDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DeleteDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSetPermissionsRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSetPermissionsResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSetRequest$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "DescribeDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSetPermissionsRequest$DataSetId": "The ID for the dataset whose permissions you want to update. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSetPermissionsResponse$DataSetId": "The ID for the dataset whose permissions you want to update. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSetRequest$DataSetId": "The ID for the dataset that you want to update. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSetResponse$DataSetId": "The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.
",
"UpdateDataSetResponse$IngestionId": "The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
",
- "UpdateDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
",
- "UpdateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
"
+ "UpdateDataSourcePermissionsRequest$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSourcePermissionsResponse$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSourceRequest$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
",
+ "UpdateDataSourceResponse$DataSourceId": "The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.
"
}
},
"ResourceName": {
@@ -2896,7 +2968,7 @@
"ResourcePermissionList": {
"base": null,
"refs": {
- "CreateAnalysisRequest$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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
",
+ "CreateAnalysisRequest$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.
",
"CreateDashboardRequest$Permissions": "A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
",
"CreateDataSetRequest$Permissions": "A list of resource permissions on the dataset.
",
"CreateDataSourceRequest$Permissions": "A list of resource permissions on the data source.
",
@@ -2969,6 +3041,7 @@
"AdditionalDashboardIdList$member": null,
"Analysis$AnalysisId": "The ID of the analysis.
",
"AnalysisSummary$AnalysisId": "The ID of the analysis. This ID displays in the URL.
",
+ "AnonymousUserDashboardEmbeddingConfiguration$InitialDashboardId": "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.
",
"CreateAnalysisRequest$AnalysisId": "The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
",
"CreateAnalysisResponse$AnalysisId": "The ID of the analysis.
",
"CreateDashboardRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
",
@@ -2978,10 +3051,10 @@
"CreateFolderRequest$FolderId": "The folder ID.
",
"CreateFolderResponse$FolderId": "The folder ID for the newly created folder.
",
"CreateTemplateAliasRequest$TemplateId": "An ID for the template.
",
- "CreateTemplateRequest$TemplateId": "An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
",
+ "CreateTemplateRequest$TemplateId": "An ID for the template that you want to create. This template is unique per Region; in each Amazon Web Services account;.
",
"CreateTemplateResponse$TemplateId": "The ID of the template.
",
"CreateThemeAliasRequest$ThemeId": "An ID for the theme alias.
",
- "CreateThemeRequest$ThemeId": "An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
",
+ "CreateThemeRequest$ThemeId": "An ID for the theme that you want to create. The theme ID is unique per Region; in each Amazon Web Services account;.
",
"CreateThemeRequest$BaseThemeId": "The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.
",
"CreateThemeResponse$ThemeId": "The ID of the theme.
",
"Dashboard$DashboardId": "Dashboard ID.
",
@@ -3024,7 +3097,7 @@
"Folder$FolderId": "The folder ID.
",
"FolderMember$MemberId": "The ID of the asset.
",
"FolderSummary$FolderId": "The folder ID.
",
- "GetDashboardEmbedUrlRequest$DashboardId": "The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.
",
+ "GetDashboardEmbedUrlRequest$DashboardId": "The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
",
"ListDashboardVersionsRequest$DashboardId": "The ID for the dashboard.
",
"ListFolderMembersRequest$FolderId": "The folder ID.
",
"ListTemplateAliasesRequest$TemplateId": "The ID for the template.
",
@@ -3032,13 +3105,14 @@
"ListThemeAliasesRequest$ThemeId": "The ID for the theme.
",
"ListThemeVersionsRequest$ThemeId": "The ID for the theme.
",
"MemberIdArnPair$MemberId": "The ID of the member.
",
+ "RegisteredUserDashboardEmbeddingConfiguration$InitialDashboardId": "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.
",
"RestoreAnalysisRequest$AnalysisId": "The ID of the analysis that you're restoring.
",
"RestoreAnalysisResponse$AnalysisId": "The ID of the analysis that you're restoring.
",
"Sheet$SheetId": "The unique identifier associated with a sheet.
",
- "Template$TemplateId": "The ID for the template. This is unique per AWS Region for each AWS account.
",
- "TemplateSummary$TemplateId": "The ID of the template. This ID is unique per AWS Region for each AWS account.
",
+ "Template$TemplateId": "The ID for the template. This is unique per Region; for each Amazon Web Services account;.
",
+ "TemplateSummary$TemplateId": "The ID of the template. This ID is unique per Region; for each Amazon Web Services account;.
",
"Theme$ThemeId": "The identifier that the user gives to the theme.
",
- "ThemeSummary$ThemeId": "The ID of the theme. This ID is unique per AWS Region for each AWS account.
",
+ "ThemeSummary$ThemeId": "The ID of the theme. This ID is unique per Region; for each Amazon Web Services account;.
",
"ThemeVersion$BaseThemeId": "The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
",
"UpdateAnalysisPermissionsRequest$AnalysisId": "The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
",
"UpdateAnalysisPermissionsResponse$AnalysisId": "The ID of the analysis that you updated permissions for.
",
@@ -3063,15 +3137,15 @@
"UpdateThemePermissionsRequest$ThemeId": "The ID for the theme.
",
"UpdateThemePermissionsResponse$ThemeId": "The ID for the theme.
",
"UpdateThemeRequest$ThemeId": "The ID for the theme.
",
- "UpdateThemeRequest$BaseThemeId": "The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
",
+ "UpdateThemeRequest$BaseThemeId": "The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
",
"UpdateThemeResponse$ThemeId": "The ID for the theme.
"
}
},
"RoleName": {
"base": null,
"refs": {
- "RegisterUserRequest$CustomPermissionsName": "(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).
",
- "UpdateUserRequest$CustomPermissionsName": "(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).
",
+ "RegisterUserRequest$CustomPermissionsName": "(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.
",
+ "UpdateUserRequest$CustomPermissionsName": "(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.
",
"User$CustomPermissionsName": "The custom permissions profile associated with this user.
"
}
},
@@ -3108,6 +3182,32 @@
"RowLevelPermissionDataSet$PermissionPolicy": "The type of permissions to use when interpretting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
"
}
},
+ "RowLevelPermissionTagConfiguration": {
+ "base": "The configuration of tags on a dataset to set row-level security.
",
+ "refs": {
+ "CreateDataSetRequest$RowLevelPermissionTagConfiguration": "The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
",
+ "DataSet$RowLevelPermissionTagConfiguration": "The element you can use to define tags for row-level security.
",
+ "UpdateDataSetRequest$RowLevelPermissionTagConfiguration": "The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
"
+ }
+ },
+ "RowLevelPermissionTagDelimiter": {
+ "base": null,
+ "refs": {
+ "RowLevelPermissionTagRule$TagMultiValueDelimiter": "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.
"
+ }
+ },
+ "RowLevelPermissionTagRule": {
+ "base": "A set of rules associated with a tag.
",
+ "refs": {
+ "RowLevelPermissionTagRuleList$member": null
+ }
+ },
+ "RowLevelPermissionTagRuleList": {
+ "base": null,
+ "refs": {
+ "RowLevelPermissionTagConfiguration$TagRules": "A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
"
+ }
+ },
"S3Bucket": {
"base": null,
"refs": {
@@ -3171,6 +3271,8 @@
"SessionLifetimeInMinutes": {
"base": null,
"refs": {
+ "GenerateEmbedUrlForAnonymousUserRequest$SessionLifetimeInMinutes": "How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
",
+ "GenerateEmbedUrlForRegisteredUserRequest$SessionLifetimeInMinutes": "How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
",
"GetDashboardEmbedUrlRequest$SessionLifetimeInMinutes": "How many minutes the session is valid. The session lifetime must be 15-600 minutes.
",
"GetSessionEmbedUrlRequest$SessionLifetimeInMinutes": "How many minutes the session is valid. The session lifetime must be 15-600 minutes.
"
}
@@ -3180,8 +3282,34 @@
"refs": {
}
},
+ "SessionTag": {
+ "base": "The key-value pair used for the row-level security tags feature.
",
+ "refs": {
+ "SessionTagList$member": null
+ }
+ },
+ "SessionTagKey": {
+ "base": null,
+ "refs": {
+ "RowLevelPermissionTagRule$TagKey": "The unique key for a tag.
",
+ "SessionTag$Key": "The key for the tag.
"
+ }
+ },
+ "SessionTagList": {
+ "base": null,
+ "refs": {
+ "GenerateEmbedUrlForAnonymousUserRequest$SessionTags": "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.
"
+ }
+ },
+ "SessionTagValue": {
+ "base": null,
+ "refs": {
+ "RowLevelPermissionTagRule$MatchAllValue": "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.
",
+ "SessionTag$Value": "The value that you want to assign the tag.
"
+ }
+ },
"Sheet": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"SheetList$member": null
}
@@ -3245,6 +3373,13 @@
"UpdateDataSourceRequest$SslProperties": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
"
}
},
+ "Status": {
+ "base": null,
+ "refs": {
+ "RowLevelPermissionDataSet$Status": "The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
",
+ "RowLevelPermissionTagConfiguration$Status": "The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
"
+ }
+ },
"StatusCode": {
"base": null,
"refs": {
@@ -3306,6 +3441,8 @@
"DescribeThemePermissionsResponse$Status": "The HTTP status of the request.
",
"DescribeThemeResponse$Status": "The HTTP status of the request.
",
"DescribeUserResponse$Status": "The HTTP status of the request.
",
+ "GenerateEmbedUrlForAnonymousUserResponse$Status": "The HTTP status of the request.
",
+ "GenerateEmbedUrlForRegisteredUserResponse$Status": "The HTTP status of the request.
",
"GetDashboardEmbedUrlResponse$Status": "The HTTP status of the request.
",
"GetSessionEmbedUrlResponse$Status": "The HTTP status of the request.
",
"ListAnalysesResponse$Status": "The HTTP status of the request.
",
@@ -3365,8 +3502,8 @@
"base": null,
"refs": {
"AccessDeniedException$Message": null,
- "AccessDeniedException$RequestId": "The AWS request ID for this request.
",
- "AccountSettings$AccountName": "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.
",
+ "AccessDeniedException$RequestId": "The Amazon Web Services request ID for this request.
",
+ "AccountSettings$AccountName": "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.
",
"AccountSettings$NotificationEmail": "The main notification email for your QuickSight subscription.
",
"ActionList$member": null,
"AnalysisSearchFilter$Value": "The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example \"Value\". An example is \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".
",
@@ -3379,102 +3516,104 @@
"ConcurrentUpdatingException$Message": null,
"ConcurrentUpdatingException$RequestId": null,
"ConflictException$Message": null,
- "ConflictException$RequestId": "The AWS request ID for this request.
",
- "CreateAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateAnalysisResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateDashboardResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateDataSetResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateDataSourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "ConflictException$RequestId": "The Amazon Web Services request ID for this request.
",
+ "CreateAccountCustomizationResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateAnalysisResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateDashboardResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateDataSetResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateDataSourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"CreateFolderMembershipResponse$RequestId": "The request ID.
",
"CreateFolderResponse$RequestId": "The request ID for the newly created folder.
",
- "CreateGroupMembershipResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateGroupResponse$RequestId": "The AWS request ID for this operation.
",
+ "CreateGroupMembershipResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"CreateIAMPolicyAssignmentResponse$AssignmentId": "The ID for the assignment.
",
- "CreateIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateNamespaceResponse$CapacityRegion": "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.
",
- "CreateNamespaceResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateTemplateAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateTemplateResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateThemeAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "CreateThemeResponse$RequestId": "The AWS request ID for this operation.
",
+ "CreateIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateNamespaceResponse$CapacityRegion": "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.
",
+ "CreateNamespaceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateTemplateResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateThemeAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "CreateThemeResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DashboardSearchFilter$Value": "The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".
",
"DataSetConfiguration$Placeholder": "Placeholder.
",
"DataSourceErrorInfo$Message": "Error message.
",
- "DeleteAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteAnalysisResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteDashboardResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteDataSetResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteDataSourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "DeleteAccountCustomizationResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteAnalysisResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteDashboardResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteDataSetResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteDataSourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DeleteFolderMembershipResponse$RequestId": "The request ID.
",
"DeleteFolderResponse$RequestId": "The request ID.
",
- "DeleteGroupMembershipResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteGroupResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteNamespaceResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteTemplateAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteTemplateResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteThemeAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteThemeResponse$RequestId": "The AWS request ID for this operation.
",
+ "DeleteGroupMembershipResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteNamespaceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteTemplateResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteThemeAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteThemeResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DeleteUserByPrincipalIdRequest$PrincipalId": "The principal ID of the user.
",
- "DeleteUserByPrincipalIdResponse$RequestId": "The AWS request ID for this operation.
",
- "DeleteUserResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeAccountSettingsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeAnalysisPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeAnalysisResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDashboardPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDashboardResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDataSetPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDataSetResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDataSourcePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeDataSourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "DeleteUserByPrincipalIdResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DeleteUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeAccountCustomizationResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeAccountSettingsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeAnalysisPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeAnalysisResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDashboardPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDashboardResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDataSetPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDataSetResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDataSourcePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeDataSourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DescribeFolderPermissionsResponse$RequestId": "The request ID.
",
"DescribeFolderResolvedPermissionsResponse$RequestId": "The request ID.
",
"DescribeFolderResponse$RequestId": "The request ID.
",
- "DescribeGroupResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeNamespaceResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeTemplateAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeTemplatePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeTemplateResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeThemeAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeThemePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeThemeResponse$RequestId": "The AWS request ID for this operation.
",
- "DescribeUserResponse$RequestId": "The AWS request ID for this operation.
",
+ "DescribeGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeNamespaceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeTemplatePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeTemplateResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeThemeAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeThemePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeThemeResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "DescribeUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DomainNotWhitelistedException$Message": null,
- "DomainNotWhitelistedException$RequestId": "The AWS request ID for this request.
",
+ "DomainNotWhitelistedException$RequestId": "The Amazon Web Services request ID for this request.
",
"FolderColumnList$member": null,
"FolderSearchFilter$Value": "The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".
",
- "GetDashboardEmbedUrlResponse$RequestId": "The AWS request ID for this operation.
",
- "GetSessionEmbedUrlResponse$RequestId": "The AWS request ID for this operation.
",
+ "GenerateEmbedUrlForAnonymousUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "GenerateEmbedUrlForRegisteredUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "GetDashboardEmbedUrlResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "GetSessionEmbedUrlResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"Group$PrincipalId": "The principal ID of the group.
",
"IAMPolicyAssignment$AssignmentId": "Assignment ID.
",
"IdentityMap$key": null,
"IdentityTypeNotSupportedException$Message": null,
- "IdentityTypeNotSupportedException$RequestId": "The AWS request ID for this request.
",
+ "IdentityTypeNotSupportedException$RequestId": "The Amazon Web Services request ID for this request.
",
"InternalFailureException$Message": null,
- "InternalFailureException$RequestId": "The AWS request ID for this request.
",
+ "InternalFailureException$RequestId": "The Amazon Web Services request ID for this request.
",
"InvalidNextTokenException$Message": null,
- "InvalidNextTokenException$RequestId": "The AWS request ID for this request.
",
+ "InvalidNextTokenException$RequestId": "The Amazon Web Services request ID for this request.
",
"InvalidParameterValueException$Message": null,
- "InvalidParameterValueException$RequestId": "The AWS request ID for this request.
",
+ "InvalidParameterValueException$RequestId": "The Amazon Web Services request ID for this request.
",
"LimitExceededException$Message": null,
- "LimitExceededException$RequestId": "The AWS request ID for this request.
",
+ "LimitExceededException$RequestId": "The Amazon Web Services request ID for this request.
",
"ListAnalysesRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListAnalysesResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListAnalysesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListAnalysesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListDashboardVersionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListDashboardVersionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListDashboardVersionsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListDashboardVersionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListDashboardsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListDashboardsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListDashboardsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListDashboardsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListDataSetsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListDataSetsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListDataSetsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListDataSetsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListDataSourcesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListDataSourcesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListDataSourcesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListDataSourcesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListFolderMembersRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListFolderMembersResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListFolderMembersResponse$RequestId": "The request ID.
",
@@ -3483,114 +3622,115 @@
"ListFoldersResponse$RequestId": "The request ID.
",
"ListGroupMembershipsRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListGroupMembershipsResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListGroupMembershipsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListGroupMembershipsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListGroupsRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListGroupsResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListGroupsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListGroupsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListIAMPolicyAssignmentsForUserRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListIAMPolicyAssignmentsForUserResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListIAMPolicyAssignmentsForUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListIAMPolicyAssignmentsForUserResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListIAMPolicyAssignmentsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListIAMPolicyAssignmentsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListIAMPolicyAssignmentsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListIAMPolicyAssignmentsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListNamespacesRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListNamespacesResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListNamespacesResponse$RequestId": "The AWS request ID for this operation.
",
- "ListTagsForResourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListNamespacesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "ListTagsForResourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListTemplateAliasesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListTemplateAliasesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListTemplateAliasesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListTemplateAliasesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListTemplateVersionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListTemplateVersionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListTemplateVersionsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListTemplateVersionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListTemplatesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListTemplatesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListTemplatesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListTemplatesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListThemeAliasesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListThemeAliasesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListThemeAliasesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListThemeAliasesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListThemeVersionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListThemeVersionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListThemeVersionsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListThemeVersionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListThemesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListThemesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListThemesResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListThemesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListUserGroupsRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListUserGroupsResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListUserGroupsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListUserGroupsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ListUsersRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"ListUsersResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "ListUsersResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListUsersResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"NamespaceError$Message": "The message for the error.
",
- "NamespaceInfoV2$CapacityRegion": "The namespace AWS Region.
",
+ "NamespaceInfoV2$CapacityRegion": "The namespace Region;.
",
"PreconditionNotMetException$Message": null,
- "PreconditionNotMetException$RequestId": "The AWS request ID for this request.
",
+ "PreconditionNotMetException$RequestId": "The Amazon Web Services request ID for this request.
",
"PrincipalList$member": null,
"ProjectedColumnList$member": null,
"QuickSightUserNotFoundException$Message": null,
- "QuickSightUserNotFoundException$RequestId": "The AWS request ID for this request.
",
+ "QuickSightUserNotFoundException$RequestId": "The Amazon Web Services request ID for this request.
",
"RegisterUserRequest$Email": "The email address of the user that you want to register.
",
"RegisterUserRequest$IamArn": "The ARN of the IAM user or role that you are registering with Amazon QuickSight.
",
"RegisterUserRequest$ExternalLoginFederationProviderType": "The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
-
COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
-
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
",
"RegisterUserRequest$CustomFederationProviderUrl": "The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
",
"RegisterUserRequest$ExternalLoginId": "The identity ID for a user in the external login provider.
",
"RegisterUserResponse$UserInvitationUrl": "The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
",
- "RegisterUserResponse$RequestId": "The AWS request ID for this operation.
",
+ "RegisterUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ResourceExistsException$Message": null,
- "ResourceExistsException$RequestId": "The AWS request ID for this request.
",
+ "ResourceExistsException$RequestId": "The Amazon Web Services request ID for this request.
",
"ResourceNotFoundException$Message": null,
- "ResourceNotFoundException$RequestId": "The AWS request ID for this request.
",
+ "ResourceNotFoundException$RequestId": "The Amazon Web Services request ID for this request.
",
"ResourceUnavailableException$Message": null,
- "ResourceUnavailableException$RequestId": "The AWS request ID for this request.
",
- "RestoreAnalysisResponse$RequestId": "The AWS request ID for this operation.
",
+ "ResourceUnavailableException$RequestId": "The Amazon Web Services request ID for this request.
",
+ "RestoreAnalysisResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "RowLevelPermissionTagRule$ColumnName": "The column name that a tag key is assigned to.
",
"SearchAnalysesRequest$NextToken": "A pagination token that can be used in a subsequent request.
",
"SearchAnalysesResponse$NextToken": "A pagination token that can be used in a subsequent request.
",
- "SearchAnalysesResponse$RequestId": "The AWS request ID for this operation.
",
+ "SearchAnalysesResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"SearchDashboardsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"SearchDashboardsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "SearchDashboardsResponse$RequestId": "The AWS request ID for this operation.
",
+ "SearchDashboardsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"SearchFoldersRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"SearchFoldersResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
"SearchFoldersResponse$RequestId": "The request ID.
",
"SessionLifetimeInMinutesInvalidException$Message": null,
- "SessionLifetimeInMinutesInvalidException$RequestId": "The AWS request ID for this request.
",
+ "SessionLifetimeInMinutesInvalidException$RequestId": "The Amazon Web Services request ID for this request.
",
"StringList$member": null,
- "TagResourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "TagResourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ThrottlingException$Message": null,
- "ThrottlingException$RequestId": "The AWS request ID for this request.
",
+ "ThrottlingException$RequestId": "The Amazon Web Services request ID for this request.
",
"UnsupportedPricingPlanException$Message": null,
- "UnsupportedPricingPlanException$RequestId": "The AWS request ID for this request.
",
+ "UnsupportedPricingPlanException$RequestId": "The Amazon Web Services request ID for this request.
",
"UnsupportedUserEditionException$Message": null,
- "UnsupportedUserEditionException$RequestId": "The AWS request ID for this request.
",
- "UntagResourceResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateAccountSettingsRequest$NotificationEmail": "The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.
",
- "UpdateAccountSettingsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateAnalysisPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateAnalysisResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDashboardPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDashboardPublishedVersionResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDashboardResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDataSetPermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDataSetResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDataSourcePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateDataSourceResponse$RequestId": "The AWS request ID for this operation.
",
+ "UnsupportedUserEditionException$RequestId": "The Amazon Web Services request ID for this request.
",
+ "UntagResourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateAccountCustomizationResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateAccountSettingsRequest$NotificationEmail": "The email address that you want QuickSight to send notifications to regarding your Amazon Web Services account; or QuickSight subscription.
",
+ "UpdateAccountSettingsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateAnalysisPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateAnalysisResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDashboardPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDashboardPublishedVersionResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDashboardResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDataSetPermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDataSetResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDataSourcePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateDataSourceResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"UpdateFolderPermissionsResponse$RequestId": "The request ID.
",
"UpdateFolderResponse$RequestId": "The request ID.
",
- "UpdateGroupResponse$RequestId": "The AWS request ID for this operation.
",
+ "UpdateGroupResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"UpdateIAMPolicyAssignmentResponse$AssignmentId": "The ID of the assignment.
",
- "UpdateIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateTemplateAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateTemplatePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateTemplateResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateThemeAliasResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateThemePermissionsResponse$RequestId": "The AWS request ID for this operation.
",
- "UpdateThemeResponse$RequestId": "The AWS request ID for this operation.
",
+ "UpdateIAMPolicyAssignmentResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateTemplateAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateTemplatePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateTemplateResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateThemeAliasResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateThemePermissionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
+ "UpdateThemeResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"UpdateUserRequest$Email": "The email address of the user that you want to update.
",
"UpdateUserRequest$ExternalLoginFederationProviderType": "The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
-
COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
-
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
-
NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.
",
"UpdateUserRequest$CustomFederationProviderUrl": "The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
",
"UpdateUserRequest$ExternalLoginId": "The identity ID for a user in the external login provider.
",
- "UpdateUserResponse$RequestId": "The AWS request ID for this operation.
",
+ "UpdateUserResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"User$Email": "The user's email address.
",
"User$PrincipalId": "The principal ID of the user.
",
"User$ExternalLoginFederationProviderType": "The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
",
@@ -3674,7 +3814,7 @@
}
},
"Template": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"DescribeTemplateResponse$Template": "The template structure for the object you want to describe.
"
}
@@ -3730,8 +3870,8 @@
"TemplateSourceEntity": {
"base": "The source entity of the template.
",
"refs": {
- "CreateTemplateRequest$SourceEntity": "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.
",
- "UpdateTemplateRequest$SourceEntity": "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.
"
+ "CreateTemplateRequest$SourceEntity": "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.
",
+ "UpdateTemplateRequest$SourceEntity": "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.
"
}
},
"TemplateSourceTemplate": {
@@ -3853,7 +3993,7 @@
"ThemeType": {
"base": null,
"refs": {
- "ListThemesRequest$Type": "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.
",
+ "ListThemesRequest$Type": "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.
",
"Theme$Type": "The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.
"
}
},
@@ -3970,7 +4110,7 @@
}
},
"UnsupportedPricingPlanException": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -4356,16 +4496,16 @@
"base": null,
"refs": {
"CancelIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
",
- "CancelIngestionResponse$RequestId": "The AWS request ID for this operation.
",
+ "CancelIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"CreateIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
",
- "CreateIngestionResponse$RequestId": "The AWS request ID for this operation.
",
+ "CreateIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"DescribeIngestionRequest$DataSetId": "The ID of the dataset used in the ingestion.
",
- "DescribeIngestionResponse$RequestId": "The AWS request ID for this operation.
",
+ "DescribeIngestionResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"ErrorInfo$Message": "Error message.
",
"ListIngestionsRequest$DataSetId": "The ID of the dataset used in the ingestion.
",
"ListIngestionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
",
"ListIngestionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
",
- "ListIngestionsResponse$RequestId": "The AWS request ID for this operation.
",
+ "ListIngestionsResponse$RequestId": "The Amazon Web Services request ID for this operation.
",
"QueueInfo$WaitingOnIngestion": "The ID of the queued ingestion.
",
"QueueInfo$QueuedIngestion": "The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
"
}
diff --git a/models/apis/redshift-data/2019-12-20/api-2.json b/models/apis/redshift-data/2019-12-20/api-2.json
index 824db66aff..d5b24234f6 100644
--- a/models/apis/redshift-data/2019-12-20/api-2.json
+++ b/models/apis/redshift-data/2019-12-20/api-2.json
@@ -13,6 +13,20 @@
"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"}
+ ]
+ },
"CancelStatement":{
"name":"CancelStatement",
"http":{
@@ -22,6 +36,7 @@
"input":{"shape":"CancelStatementRequest"},
"output":{"shape":"CancelStatementResponse"},
"errors":[
+ {"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
]
@@ -142,6 +157,47 @@
},
"exception":true
},
+ "BatchExecuteStatementException":{
+ "type":"structure",
+ "required":[
+ "Message",
+ "StatementId"
+ ],
+ "members":{
+ "Message":{"shape":"String"},
+ "StatementId":{"shape":"String"}
+ },
+ "exception":true,
+ "fault":true
+ },
+ "BatchExecuteStatementInput":{
+ "type":"structure",
+ "required":[
+ "ClusterIdentifier",
+ "Database",
+ "Sqls"
+ ],
+ "members":{
+ "ClusterIdentifier":{"shape":"Location"},
+ "Database":{"shape":"String"},
+ "DbUser":{"shape":"String"},
+ "SecretArn":{"shape":"SecretArn"},
+ "Sqls":{"shape":"SqlList"},
+ "StatementName":{"shape":"StatementNameString"},
+ "WithEvent":{"shape":"Boolean"}
+ }
+ },
+ "BatchExecuteStatementOutput":{
+ "type":"structure",
+ "members":{
+ "ClusterIdentifier":{"shape":"Location"},
+ "CreatedAt":{"shape":"Timestamp"},
+ "Database":{"shape":"String"},
+ "DbUser":{"shape":"String"},
+ "Id":{"shape":"StatementId"},
+ "SecretArn":{"shape":"SecretArn"}
+ }
+ },
"Blob":{"type":"blob"},
"Boolean":{
"type":"boolean",
@@ -163,7 +219,7 @@
"type":"structure",
"required":["Id"],
"members":{
- "Id":{"shape":"UUID"}
+ "Id":{"shape":"StatementId"}
}
},
"CancelStatementResponse":{
@@ -206,7 +262,7 @@
"type":"structure",
"required":["Id"],
"members":{
- "Id":{"shape":"UUID"}
+ "Id":{"shape":"StatementId"}
}
},
"DescribeStatementResponse":{
@@ -220,7 +276,7 @@
"Duration":{"shape":"Long"},
"Error":{"shape":"String"},
"HasResultSet":{"shape":"Boolean"},
- "Id":{"shape":"UUID"},
+ "Id":{"shape":"StatementId"},
"QueryParameters":{"shape":"SqlParametersList"},
"QueryString":{"shape":"StatementString"},
"RedshiftPid":{"shape":"Long"},
@@ -229,6 +285,7 @@
"ResultSize":{"shape":"Long"},
"SecretArn":{"shape":"SecretArn"},
"Status":{"shape":"StatusString"},
+ "SubStatements":{"shape":"SubStatementList"},
"UpdatedAt":{"shape":"Timestamp"}
}
},
@@ -275,6 +332,7 @@
"type":"structure",
"required":[
"ClusterIdentifier",
+ "Database",
"Sql"
],
"members":{
@@ -295,7 +353,7 @@
"CreatedAt":{"shape":"Timestamp"},
"Database":{"shape":"String"},
"DbUser":{"shape":"String"},
- "Id":{"shape":"UUID"},
+ "Id":{"shape":"StatementId"},
"SecretArn":{"shape":"SecretArn"}
}
},
@@ -319,7 +377,7 @@
"type":"structure",
"required":["Id"],
"members":{
- "Id":{"shape":"UUID"},
+ "Id":{"shape":"StatementId"},
"NextToken":{"shape":"String"}
}
},
@@ -345,7 +403,10 @@
},
"ListDatabasesRequest":{
"type":"structure",
- "required":["ClusterIdentifier"],
+ "required":[
+ "ClusterIdentifier",
+ "Database"
+ ],
"members":{
"ClusterIdentifier":{"shape":"Location"},
"Database":{"shape":"String"},
@@ -466,6 +527,12 @@
"member":{"shape":"String"}
},
"SecretArn":{"type":"string"},
+ "SqlList":{
+ "type":"list",
+ "member":{"shape":"StatementString"},
+ "max":40,
+ "min":1
+ },
"SqlParameter":{
"type":"structure",
"required":[
@@ -491,15 +558,21 @@
"required":["Id"],
"members":{
"CreatedAt":{"shape":"Timestamp"},
- "Id":{"shape":"UUID"},
+ "Id":{"shape":"StatementId"},
+ "IsBatchStatement":{"shape":"Boolean"},
"QueryParameters":{"shape":"SqlParametersList"},
"QueryString":{"shape":"StatementString"},
+ "QueryStrings":{"shape":"StatementStringList"},
"SecretArn":{"shape":"SecretArn"},
"StatementName":{"shape":"StatementNameString"},
"Status":{"shape":"StatusString"},
"UpdatedAt":{"shape":"Timestamp"}
}
},
+ "StatementId":{
+ "type":"string",
+ "pattern":"^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$"
+ },
"StatementList":{
"type":"list",
"member":{"shape":"StatementData"}
@@ -509,7 +582,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":[
@@ -523,6 +611,27 @@
]
},
"String":{"type":"string"},
+ "SubStatementData":{
+ "type":"structure",
+ "required":["Id"],
+ "members":{
+ "CreatedAt":{"shape":"Timestamp"},
+ "Duration":{"shape":"Long"},
+ "Error":{"shape":"String"},
+ "HasResultSet":{"shape":"Boolean"},
+ "Id":{"shape":"StatementId"},
+ "QueryString":{"shape":"StatementString"},
+ "RedshiftQueryId":{"shape":"Long"},
+ "ResultRows":{"shape":"Long"},
+ "ResultSize":{"shape":"Long"},
+ "Status":{"shape":"StatementStatusString"},
+ "UpdatedAt":{"shape":"Timestamp"}
+ }
+ },
+ "SubStatementList":{
+ "type":"list",
+ "member":{"shape":"SubStatementData"}
+ },
"TableList":{
"type":"list",
"member":{"shape":"TableMember"}
@@ -536,7 +645,6 @@
}
},
"Timestamp":{"type":"timestamp"},
- "UUID":{"type":"string"},
"ValidationException":{
"type":"structure",
"members":{
diff --git a/models/apis/redshift-data/2019-12-20/docs-2.json b/models/apis/redshift-data/2019-12-20/docs-2.json
index c0be6253b3..ac61c11891 100644
--- a/models/apis/redshift-data/2019-12-20/docs-2.json
+++ b/models/apis/redshift-data/2019-12-20/docs-2.json
@@ -1,16 +1,17 @@
{
"version": "2.0",
- "service": "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.
",
+ "service": "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.
",
"operations": {
+ "BatchExecuteStatement": "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.
",
"CancelStatement": "Cancels a running query. To be canceled, a query must be running.
",
"DescribeStatement": "Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.
",
- "DescribeTable": "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.
",
- "ExecuteStatement": "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.
",
+ "DescribeTable": "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.
",
+ "ExecuteStatement": "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.
",
"GetStatementResult": "Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
",
- "ListDatabases": "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.
",
- "ListSchemas": "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.
",
+ "ListDatabases": "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.
",
+ "ListSchemas": "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.
",
"ListStatements": "List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
",
- "ListTables": "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.
"
+ "ListTables": "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.
"
},
"shapes": {
"ActiveStatementsExceededException": {
@@ -18,6 +19,21 @@
"refs": {
}
},
+ "BatchExecuteStatementException": {
+ "base": "An SQL statement encountered an environmental error while running.
",
+ "refs": {
+ }
+ },
+ "BatchExecuteStatementInput": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "BatchExecuteStatementOutput": {
+ "base": null,
+ "refs": {
+ }
+ },
"Blob": {
"base": null,
"refs": {
@@ -27,10 +43,13 @@
"Boolean": {
"base": null,
"refs": {
+ "BatchExecuteStatementInput$WithEvent": "A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
",
"CancelStatementResponse$Status": "A value that indicates whether the cancel statement succeeded (true).
",
"DescribeStatementResponse$HasResultSet": "A value that indicates whether the statement has a result set. The result set can be empty.
",
"ExecuteStatementInput$WithEvent": "A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
",
- "ListStatementsRequest$RoleLevel": "A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
"
+ "ListStatementsRequest$RoleLevel": "A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
",
+ "StatementData$IsBatchStatement": "A value that indicates whether the statement is a batch query request.
",
+ "SubStatementData$HasResultSet": "A value that indicates whether the statement has a result set. The result set can be empty.
"
}
},
"BoxedBoolean": {
@@ -207,12 +226,14 @@
"Location": {
"base": null,
"refs": {
- "DescribeTableRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
",
- "ExecuteStatementInput$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
",
+ "BatchExecuteStatementInput$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
+ "BatchExecuteStatementOutput$ClusterIdentifier": "The cluster identifier.
",
+ "DescribeTableRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
+ "ExecuteStatementInput$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
"ExecuteStatementOutput$ClusterIdentifier": "The cluster identifier.
",
- "ListDatabasesRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
",
- "ListSchemasRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
",
- "ListTablesRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.
"
+ "ListDatabasesRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
+ "ListSchemasRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
+ "ListTablesRequest$ClusterIdentifier": "The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
"
}
},
"Long": {
@@ -221,9 +242,13 @@
"DescribeStatementResponse$Duration": "The amount of time in nanoseconds that the statement ran.
",
"DescribeStatementResponse$RedshiftPid": "The process identifier from Amazon Redshift.
",
"DescribeStatementResponse$RedshiftQueryId": "The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
",
- "DescribeStatementResponse$ResultRows": "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.
",
- "DescribeStatementResponse$ResultSize": "The size in bytes of the returned results.
",
- "GetStatementResultResponse$TotalNumRows": "The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.
"
+ "DescribeStatementResponse$ResultRows": "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.
",
+ "DescribeStatementResponse$ResultSize": "The size in bytes of the returned results. A -1 indicates the value is null.
",
+ "GetStatementResultResponse$TotalNumRows": "The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.
",
+ "SubStatementData$Duration": "The amount of time in nanoseconds that the statement ran.
",
+ "SubStatementData$RedshiftQueryId": "The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
",
+ "SubStatementData$ResultRows": "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.
",
+ "SubStatementData$ResultSize": "The size in bytes of the returned results. A -1 indicates the value is null.
"
}
},
"PageSize": {
@@ -261,16 +286,24 @@
"SecretArn": {
"base": null,
"refs": {
+ "BatchExecuteStatementInput$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
+ "BatchExecuteStatementOutput$SecretArn": "The name or ARN of the secret that enables access to the database.
",
"DescribeStatementResponse$SecretArn": "The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
",
- "DescribeTableRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
",
- "ExecuteStatementInput$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
",
+ "DescribeTableRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
+ "ExecuteStatementInput$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
"ExecuteStatementOutput$SecretArn": "The name or ARN of the secret that enables access to the database.
",
- "ListDatabasesRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
",
- "ListSchemasRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
",
- "ListTablesRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.
",
+ "ListDatabasesRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
+ "ListSchemasRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
+ "ListTablesRequest$SecretArn": "The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
",
"StatementData$SecretArn": "The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
"
}
},
+ "SqlList": {
+ "base": null,
+ "refs": {
+ "BatchExecuteStatementInput$Sqls": "One or more SQL statements to run.
"
+ }
+ },
"SqlParameter": {
"base": "A parameter used in a SQL statement.
",
"refs": {
@@ -297,6 +330,19 @@
"StatementList$member": null
}
},
+ "StatementId": {
+ "base": null,
+ "refs": {
+ "BatchExecuteStatementOutput$Id": "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.
",
+ "CancelStatementRequest$Id": "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.
",
+ "DescribeStatementRequest$Id": "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.
",
+ "DescribeStatementResponse$Id": "The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
",
+ "ExecuteStatementOutput$Id": "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.
",
+ "GetStatementResultRequest$Id": "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.
",
+ "StatementData$Id": "The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
",
+ "SubStatementData$Id": "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.
"
+ }
+ },
"StatementList": {
"base": null,
"refs": {
@@ -306,17 +352,33 @@
"StatementNameString": {
"base": null,
"refs": {
+ "BatchExecuteStatementInput$StatementName": "The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
",
"ExecuteStatementInput$StatementName": "The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
",
- "ListStatementsRequest$StatementName": "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.
",
+ "ListStatementsRequest$StatementName": "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.
",
"StatementData$StatementName": "The name of the SQL statement.
"
}
},
+ "StatementStatusString": {
+ "base": null,
+ "refs": {
+ "SubStatementData$Status": "The status of the SQL statement. An example is the that the SQL statement finished.
"
+ }
+ },
"StatementString": {
"base": null,
"refs": {
"DescribeStatementResponse$QueryString": "The SQL statement text.
",
"ExecuteStatementInput$Sql": "The SQL statement text to run.
",
- "StatementData$QueryString": "The SQL statement.
"
+ "SqlList$member": null,
+ "StatementData$QueryString": "The SQL statement.
",
+ "StatementStringList$member": null,
+ "SubStatementData$QueryString": "The SQL statement text.
"
+ }
+ },
+ "StatementStringList": {
+ "base": null,
+ "refs": {
+ "StatementData$QueryStrings": "One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.
"
}
},
"StatusString": {
@@ -331,6 +393,12 @@
"base": null,
"refs": {
"ActiveStatementsExceededException$Message": null,
+ "BatchExecuteStatementException$Message": null,
+ "BatchExecuteStatementException$StatementId": "Statement identifier of the exception.
",
+ "BatchExecuteStatementInput$Database": "The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
+ "BatchExecuteStatementInput$DbUser": "The database user name. This parameter is required when authenticating using temporary credentials.
",
+ "BatchExecuteStatementOutput$Database": "The name of the database.
",
+ "BatchExecuteStatementOutput$DbUser": "The database user name.
",
"ColumnMetadata$columnDefault": "The default value of the column.
",
"ColumnMetadata$label": "The label for the column.
",
"ColumnMetadata$name": "The name of the column.
",
@@ -352,7 +420,7 @@
"DescribeTableResponse$TableName": "The table name.
",
"ExecuteStatementException$Message": "The exception message.
",
"ExecuteStatementException$StatementId": "Statement identifier of the exception.
",
- "ExecuteStatementInput$Database": "The name of the database. This parameter is required when authenticating using temporary credentials.
",
+ "ExecuteStatementInput$Database": "The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
"ExecuteStatementInput$DbUser": "The database user name. This parameter is required when authenticating using temporary credentials.
",
"ExecuteStatementOutput$Database": "The name of the database.
",
"ExecuteStatementOutput$DbUser": "The database user name.
",
@@ -360,7 +428,7 @@
"GetStatementResultRequest$NextToken": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
",
"GetStatementResultResponse$NextToken": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
",
"InternalServerException$Message": "The exception message.
",
- "ListDatabasesRequest$Database": "The name of the database. This parameter is required when authenticating using temporary credentials.
",
+ "ListDatabasesRequest$Database": "The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
",
"ListDatabasesRequest$DbUser": "The database user name. This parameter is required when authenticating using temporary credentials.
",
"ListDatabasesRequest$NextToken": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
",
"ListDatabasesResponse$NextToken": "A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
",
@@ -382,12 +450,25 @@
"ResourceNotFoundException$Message": "The exception message.
",
"ResourceNotFoundException$ResourceId": "Resource identifier associated with the exception.
",
"SchemaList$member": null,
+ "SubStatementData$Error": "The error message from the cluster if the SQL statement encountered an error while running.
",
"TableMember$name": "The name of the table.
",
"TableMember$schema": "The schema containing the table.
",
"TableMember$type": "The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
",
"ValidationException$Message": "The exception message.
"
}
},
+ "SubStatementData": {
+ "base": "Information about an SQL statement.
",
+ "refs": {
+ "SubStatementList$member": null
+ }
+ },
+ "SubStatementList": {
+ "base": null,
+ "refs": {
+ "DescribeStatementResponse$SubStatements": "The SQL statements from a multiple statement run.
"
+ }
+ },
"TableList": {
"base": null,
"refs": {
@@ -403,22 +484,14 @@
"Timestamp": {
"base": null,
"refs": {
+ "BatchExecuteStatementOutput$CreatedAt": "The date and time (UTC) the statement was created.
",
"DescribeStatementResponse$CreatedAt": "The date and time (UTC) when the SQL statement was submitted to run.
",
"DescribeStatementResponse$UpdatedAt": "The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
",
"ExecuteStatementOutput$CreatedAt": "The date and time (UTC) the statement was created.
",
"StatementData$CreatedAt": "The date and time (UTC) the statement was created.
",
- "StatementData$UpdatedAt": "The date and time (UTC) that the statement metadata was last updated.
"
- }
- },
- "UUID": {
- "base": null,
- "refs": {
- "CancelStatementRequest$Id": "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.
",
- "DescribeStatementRequest$Id": "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.
",
- "DescribeStatementResponse$Id": "The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
",
- "ExecuteStatementOutput$Id": "The identifier of the statement to be run. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
",
- "GetStatementResultRequest$Id": "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.
",
- "StatementData$Id": "The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
"
+ "StatementData$UpdatedAt": "The date and time (UTC) that the statement metadata was last updated.
",
+ "SubStatementData$CreatedAt": "The date and time (UTC) the statement was created.
",
+ "SubStatementData$UpdatedAt": "The date and time (UTC) that the statement metadata was last updated.
"
}
},
"ValidationException": {
diff --git a/models/apis/route53-recovery-cluster/2019-12-02/api-2.json b/models/apis/route53-recovery-cluster/2019-12-02/api-2.json
new file mode 100644
index 0000000000..3dcc36cfb3
--- /dev/null
+++ b/models/apis/route53-recovery-cluster/2019-12-02/api-2.json
@@ -0,0 +1,245 @@
+{
+ "version":"2.0",
+ "metadata":{
+ "apiVersion":"2019-12-02",
+ "endpointPrefix":"route53-recovery-cluster",
+ "jsonVersion":"1.0",
+ "protocol":"json",
+ "serviceFullName":"Route53 Recovery Cluster",
+ "serviceId":"Route53 Recovery Cluster",
+ "signatureVersion":"v4",
+ "signingName":"route53-recovery-cluster",
+ "targetPrefix":"ToggleCustomerAPI",
+ "uid":"route53-recovery-cluster-2019-12-02"
+ },
+ "operations":{
+ "GetRoutingControlState":{
+ "name":"GetRoutingControlState",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetRoutingControlStateRequest"},
+ "output":{"shape":"GetRoutingControlStateResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"EndpointTemporarilyUnavailableException"}
+ ]
+ },
+ "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"}
+ ]
+ },
+ "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"}
+ ]
+ }
+ },
+ "shapes":{
+ "AccessDeniedException":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "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"},
+ "resourceId":{"shape":"String"},
+ "resourceType":{"shape":"String"}
+ },
+ "exception":true
+ },
+ "EndpointTemporarilyUnavailableException":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "exception":true
+ },
+ "GetRoutingControlStateRequest":{
+ "type":"structure",
+ "required":["RoutingControlArn"],
+ "members":{
+ "RoutingControlArn":{"shape":"Arn"}
+ }
+ },
+ "GetRoutingControlStateResponse":{
+ "type":"structure",
+ "required":[
+ "RoutingControlArn",
+ "RoutingControlState"
+ ],
+ "members":{
+ "RoutingControlArn":{"shape":"Arn"},
+ "RoutingControlState":{"shape":"RoutingControlState"}
+ }
+ },
+ "InternalServerException":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{"shape":"String"},
+ "retryAfterSeconds":{"shape":"RetryAfterSeconds"}
+ },
+ "exception":true,
+ "fault":true
+ },
+ "ResourceNotFoundException":{
+ "type":"structure",
+ "required":[
+ "message",
+ "resourceId",
+ "resourceType"
+ ],
+ "members":{
+ "message":{"shape":"String"},
+ "resourceId":{"shape":"String"},
+ "resourceType":{"shape":"String"}
+ },
+ "exception":true
+ },
+ "RetryAfterSeconds":{"type":"integer"},
+ "RoutingControlState":{
+ "type":"string",
+ "enum":[
+ "On",
+ "Off"
+ ]
+ },
+ "String":{"type":"string"},
+ "ThrottlingException":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{"shape":"String"},
+ "retryAfterSeconds":{"shape":"RetryAfterSeconds"}
+ },
+ "exception":true
+ },
+ "UpdateRoutingControlStateEntries":{
+ "type":"list",
+ "member":{"shape":"UpdateRoutingControlStateEntry"}
+ },
+ "UpdateRoutingControlStateEntry":{
+ "type":"structure",
+ "required":[
+ "RoutingControlArn",
+ "RoutingControlState"
+ ],
+ "members":{
+ "RoutingControlArn":{"shape":"Arn"},
+ "RoutingControlState":{"shape":"RoutingControlState"}
+ }
+ },
+ "UpdateRoutingControlStateRequest":{
+ "type":"structure",
+ "required":[
+ "RoutingControlArn",
+ "RoutingControlState"
+ ],
+ "members":{
+ "RoutingControlArn":{"shape":"Arn"},
+ "RoutingControlState":{"shape":"RoutingControlState"}
+ }
+ },
+ "UpdateRoutingControlStateResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "UpdateRoutingControlStatesRequest":{
+ "type":"structure",
+ "required":["UpdateRoutingControlStateEntries"],
+ "members":{
+ "UpdateRoutingControlStateEntries":{"shape":"UpdateRoutingControlStateEntries"}
+ }
+ },
+ "UpdateRoutingControlStatesResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "ValidationException":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{"shape":"String"},
+ "reason":{"shape":"ValidationExceptionReason"},
+ "fields":{"shape":"ValidationExceptionFieldList"}
+ },
+ "exception":true
+ },
+ "ValidationExceptionField":{
+ "type":"structure",
+ "required":[
+ "name",
+ "message"
+ ],
+ "members":{
+ "name":{"shape":"String"},
+ "message":{"shape":"String"}
+ }
+ },
+ "ValidationExceptionFieldList":{
+ "type":"list",
+ "member":{"shape":"ValidationExceptionField"}
+ },
+ "ValidationExceptionReason":{
+ "type":"string",
+ "enum":[
+ "unknownOperation",
+ "cannotParse",
+ "fieldValidationFailed",
+ "other"
+ ]
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json b/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json
new file mode 100644
index 0000000000..11c166d340
--- /dev/null
+++ b/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json
@@ -0,0 +1,148 @@
+{
+ "version": "2.0",
+ "service": "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:
",
+ "operations": {
+ "GetRoutingControlState": "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": "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": "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": {
+ "base": "You don't have sufficient permissions to query the routing control state.
",
+ "refs": {
+ }
+ },
+ "Arn": {
+ "base": null,
+ "refs": {
+ "GetRoutingControlStateRequest$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control that you want to get the state for.
",
+ "GetRoutingControlStateResponse$RoutingControlArn": "The Amazon Resource Number (ARN) of the response.
",
+ "UpdateRoutingControlStateEntry$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control state entry.
",
+ "UpdateRoutingControlStateRequest$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control that you want to update the state for.
"
+ }
+ },
+ "ConflictException": {
+ "base": "There was a conflict with this request. Try again.
",
+ "refs": {
+ }
+ },
+ "EndpointTemporarilyUnavailableException": {
+ "base": "The cluster endpoint isn't available. Try another cluster endpoint.
",
+ "refs": {
+ }
+ },
+ "GetRoutingControlStateRequest": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "GetRoutingControlStateResponse": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "InternalServerException": {
+ "base": "There was an unexpected error during processing of the request.
",
+ "refs": {
+ }
+ },
+ "ResourceNotFoundException": {
+ "base": "The request references a routing control that was not found.
",
+ "refs": {
+ }
+ },
+ "RetryAfterSeconds": {
+ "base": "Advice to clients on when the call can be safely retried",
+ "refs": {
+ "InternalServerException$retryAfterSeconds": null,
+ "ThrottlingException$retryAfterSeconds": null
+ }
+ },
+ "RoutingControlState": {
+ "base": null,
+ "refs": {
+ "GetRoutingControlStateResponse$RoutingControlState": "The state of the routing control.
",
+ "UpdateRoutingControlStateEntry$RoutingControlState": "The routing control state in a set of routing control state entries.
",
+ "UpdateRoutingControlStateRequest$RoutingControlState": "The state of the routing control. You can set the value to be On or Off.
"
+ }
+ },
+ "String": {
+ "base": null,
+ "refs": {
+ "AccessDeniedException$message": null,
+ "ConflictException$message": "Description of the ConflictException error",
+ "ConflictException$resourceId": "Identifier of the resource in use",
+ "ConflictException$resourceType": "Type of the resource in use",
+ "EndpointTemporarilyUnavailableException$message": null,
+ "InternalServerException$message": null,
+ "ResourceNotFoundException$message": null,
+ "ResourceNotFoundException$resourceId": "Hypothetical resource identifier that was not found",
+ "ResourceNotFoundException$resourceType": "Hypothetical resource type that was not found",
+ "ThrottlingException$message": null,
+ "ValidationException$message": null,
+ "ValidationExceptionField$name": "The field that had the validation exception.
",
+ "ValidationExceptionField$message": "Information about the validation exception.
"
+ }
+ },
+ "ThrottlingException": {
+ "base": "The request was denied because of request throttling.
",
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlStateEntries": {
+ "base": null,
+ "refs": {
+ "UpdateRoutingControlStatesRequest$UpdateRoutingControlStateEntries": "A set of routing control entries that you want to update.
"
+ }
+ },
+ "UpdateRoutingControlStateEntry": {
+ "base": "A routing control state.
",
+ "refs": {
+ "UpdateRoutingControlStateEntries$member": null
+ }
+ },
+ "UpdateRoutingControlStateRequest": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlStateResponse": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlStatesRequest": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlStatesResponse": {
+ "base": null,
+ "refs": {
+ }
+ },
+ "ValidationException": {
+ "base": "There was a validation error on the request.
",
+ "refs": {
+ }
+ },
+ "ValidationExceptionField": {
+ "base": "There was a validation error on the request.
",
+ "refs": {
+ "ValidationExceptionFieldList$member": null
+ }
+ },
+ "ValidationExceptionFieldList": {
+ "base": "The fields that caused the error, if applicable",
+ "refs": {
+ "ValidationException$fields": null
+ }
+ },
+ "ValidationExceptionReason": {
+ "base": "Reason the request failed validation",
+ "refs": {
+ "ValidationException$reason": null
+ }
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-cluster/2019-12-02/examples-1.json b/models/apis/route53-recovery-cluster/2019-12-02/examples-1.json
new file mode 100644
index 0000000000..0ea7e3b0bb
--- /dev/null
+++ b/models/apis/route53-recovery-cluster/2019-12-02/examples-1.json
@@ -0,0 +1,5 @@
+{
+ "version": "1.0",
+ "examples": {
+ }
+}
diff --git a/models/apis/route53-recovery-cluster/2019-12-02/paginators-1.json b/models/apis/route53-recovery-cluster/2019-12-02/paginators-1.json
new file mode 100644
index 0000000000..5677bd8e4a
--- /dev/null
+++ b/models/apis/route53-recovery-cluster/2019-12-02/paginators-1.json
@@ -0,0 +1,4 @@
+{
+ "pagination": {
+ }
+}
diff --git a/models/apis/route53-recovery-control-config/2020-11-02/api-2.json b/models/apis/route53-recovery-control-config/2020-11-02/api-2.json
new file mode 100644
index 0000000000..08ddcbec73
--- /dev/null
+++ b/models/apis/route53-recovery-control-config/2020-11-02/api-2.json
@@ -0,0 +1,1615 @@
+{
+ "metadata": {
+ "apiVersion": "2020-11-02",
+ "endpointPrefix": "route53-recovery-control-config",
+ "signingName": "route53-recovery-control-config",
+ "serviceFullName": "AWS Route53 Recovery Control Config",
+ "serviceId": "Route53 Recovery Control Config",
+ "protocol": "rest-json",
+ "jsonVersion": "1.1",
+ "uid": "route53-recovery-control-config-2020-11-02",
+ "signatureVersion": "v4"
+ },
+ "operations": {
+ "CreateCluster": {
+ "name": "CreateCluster",
+ "http": {
+ "method": "POST",
+ "requestUri": "/cluster",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateClusterRequest"
+ },
+ "output": {
+ "shape": "CreateClusterResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ServiceQuotaExceededException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "CreateControlPanel": {
+ "name": "CreateControlPanel",
+ "http": {
+ "method": "POST",
+ "requestUri": "/controlpanel",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateControlPanelRequest"
+ },
+ "output": {
+ "shape": "CreateControlPanelResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ServiceQuotaExceededException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "CreateRoutingControl": {
+ "name": "CreateRoutingControl",
+ "http": {
+ "method": "POST",
+ "requestUri": "/routingcontrol",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateRoutingControlRequest"
+ },
+ "output": {
+ "shape": "CreateRoutingControlResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ServiceQuotaExceededException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "CreateSafetyRule": {
+ "name": "CreateSafetyRule",
+ "http": {
+ "method": "POST",
+ "requestUri": "/safetyrule",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateSafetyRuleRequest"
+ },
+ "output": {
+ "shape": "CreateSafetyRuleResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "DeleteCluster": {
+ "name": "DeleteCluster",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/cluster/{ClusterArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteClusterRequest"
+ },
+ "output": {
+ "shape": "DeleteClusterResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DeleteControlPanel": {
+ "name": "DeleteControlPanel",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/controlpanel/{ControlPanelArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteControlPanelRequest"
+ },
+ "output": {
+ "shape": "DeleteControlPanelResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DeleteRoutingControl": {
+ "name": "DeleteRoutingControl",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/routingcontrol/{RoutingControlArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteRoutingControlRequest"
+ },
+ "output": {
+ "shape": "DeleteRoutingControlResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DeleteSafetyRule": {
+ "name": "DeleteSafetyRule",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/safetyrule/{SafetyRuleArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteSafetyRuleRequest"
+ },
+ "output": {
+ "shape": "DeleteSafetyRuleResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "DescribeCluster": {
+ "name": "DescribeCluster",
+ "http": {
+ "method": "GET",
+ "requestUri": "/cluster/{ClusterArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeClusterRequest"
+ },
+ "output": {
+ "shape": "DescribeClusterResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DescribeControlPanel": {
+ "name": "DescribeControlPanel",
+ "http": {
+ "method": "GET",
+ "requestUri": "/controlpanel/{ControlPanelArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeControlPanelRequest"
+ },
+ "output": {
+ "shape": "DescribeControlPanelResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DescribeRoutingControl": {
+ "name": "DescribeRoutingControl",
+ "http": {
+ "method": "GET",
+ "requestUri": "/routingcontrol/{RoutingControlArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeRoutingControlRequest"
+ },
+ "output": {
+ "shape": "DescribeRoutingControlResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "DescribeSafetyRule": {
+ "name": "DescribeSafetyRule",
+ "http": {
+ "method": "GET",
+ "requestUri": "/safetyrule/{SafetyRuleArn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DescribeSafetyRuleRequest"
+ },
+ "output": {
+ "shape": "DescribeSafetyRuleResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ }
+ ]
+ },
+ "ListAssociatedRoute53HealthChecks": {
+ "name": "ListAssociatedRoute53HealthChecks",
+ "http": {
+ "method": "GET",
+ "requestUri": "/routingcontrol/{RoutingControlArn}/associatedRoute53HealthChecks",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListAssociatedRoute53HealthChecksRequest"
+ },
+ "output": {
+ "shape": "ListAssociatedRoute53HealthChecksResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "ListClusters": {
+ "name": "ListClusters",
+ "http": {
+ "method": "GET",
+ "requestUri": "/cluster",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListClustersRequest"
+ },
+ "output": {
+ "shape": "ListClustersResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListControlPanels": {
+ "name": "ListControlPanels",
+ "http": {
+ "method": "GET",
+ "requestUri": "/controlpanels",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListControlPanelsRequest"
+ },
+ "output": {
+ "shape": "ListControlPanelsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListRoutingControls": {
+ "name": "ListRoutingControls",
+ "http": {
+ "method": "GET",
+ "requestUri": "/controlpanel/{ControlPanelArn}/routingcontrols",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListRoutingControlsRequest"
+ },
+ "output": {
+ "shape": "ListRoutingControlsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListSafetyRules": {
+ "name": "ListSafetyRules",
+ "http": {
+ "method": "GET",
+ "requestUri": "/controlpanel/{ControlPanelArn}/safetyrules",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListSafetyRulesRequest"
+ },
+ "output": {
+ "shape": "ListSafetyRulesResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "UpdateControlPanel": {
+ "name": "UpdateControlPanel",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/controlpanel",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateControlPanelRequest"
+ },
+ "output": {
+ "shape": "UpdateControlPanelResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "UpdateRoutingControl": {
+ "name": "UpdateRoutingControl",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/routingcontrol",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateRoutingControlRequest"
+ },
+ "output": {
+ "shape": "UpdateRoutingControlResponse"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ },
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ConflictException"
+ }
+ ]
+ },
+ "UpdateSafetyRule": {
+ "name": "UpdateSafetyRule",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/safetyrule",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateSafetyRuleRequest"
+ },
+ "output": {
+ "shape": "UpdateSafetyRuleResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ }
+ },
+ "shapes": {
+ "AccessDeniedException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 403
+ }
+ },
+ "AssertionRule": {
+ "type": "structure",
+ "members": {
+ "AssertedControls": {
+ "shape": "__listOf__string"
+ },
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RuleConfig": {
+ "shape": "RuleConfig"
+ },
+ "SafetyRuleArn": {
+ "shape": "__string"
+ },
+ "Status": {
+ "shape": "Status"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "Status",
+ "ControlPanelArn",
+ "SafetyRuleArn",
+ "AssertedControls",
+ "RuleConfig",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "AssertionRuleUpdate": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "SafetyRuleArn": {
+ "shape": "__string"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "SafetyRuleArn",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "Cluster": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string"
+ },
+ "ClusterEndpoints": {
+ "shape": "__listOfClusterEndpoint"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "Status": {
+ "shape": "Status"
+ }
+ }
+ },
+ "ClusterEndpoint": {
+ "type": "structure",
+ "members": {
+ "Endpoint": {
+ "shape": "__stringMin1Max128"
+ },
+ "Region": {
+ "shape": "__stringMin1Max32"
+ }
+ }
+ },
+ "ConflictException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 409
+ }
+ },
+ "ControlPanel": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string"
+ },
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "DefaultControlPanel": {
+ "shape": "__boolean"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RoutingControlCount": {
+ "shape": "__integer"
+ },
+ "Status": {
+ "shape": "Status"
+ }
+ }
+ },
+ "CreateClusterRequest": {
+ "type": "structure",
+ "members": {
+ "ClientToken": {
+ "shape": "__stringMax64",
+ "idempotencyToken": true
+ },
+ "ClusterName": {
+ "shape": "__stringMin1Max64PatternS"
+ }
+ },
+ "required": [
+ "ClusterName"
+ ]
+ },
+ "CreateClusterResponse": {
+ "type": "structure",
+ "members": {
+ "Cluster": {
+ "shape": "Cluster"
+ }
+ }
+ },
+ "CreateControlPanelRequest": {
+ "type": "structure",
+ "members": {
+ "ClientToken": {
+ "shape": "__stringMax64",
+ "idempotencyToken": true
+ },
+ "ClusterArn": {
+ "shape": "__string"
+ },
+ "ControlPanelName": {
+ "shape": "__stringMin1Max64PatternS"
+ }
+ },
+ "required": [
+ "ClusterArn",
+ "ControlPanelName"
+ ]
+ },
+ "CreateControlPanelResponse": {
+ "type": "structure",
+ "members": {
+ "ControlPanel": {
+ "shape": "ControlPanel"
+ }
+ }
+ },
+ "CreateRoutingControlRequest": {
+ "type": "structure",
+ "members": {
+ "ClientToken": {
+ "shape": "__stringMax64",
+ "idempotencyToken": true
+ },
+ "ClusterArn": {
+ "shape": "__string"
+ },
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "RoutingControlName": {
+ "shape": "__stringMin1Max64PatternS"
+ }
+ },
+ "required": [
+ "ClusterArn",
+ "RoutingControlName"
+ ]
+ },
+ "CreateRoutingControlResponse": {
+ "type": "structure",
+ "members": {
+ "RoutingControl": {
+ "shape": "RoutingControl"
+ }
+ }
+ },
+ "CreateSafetyRuleRequest": {
+ "type": "structure",
+ "members": {
+ "AssertionRule": {
+ "shape": "NewAssertionRule"
+ },
+ "ClientToken": {
+ "shape": "__stringMax64",
+ "idempotencyToken": true
+ },
+ "GatingRule": {
+ "shape": "NewGatingRule"
+ }
+ }
+ },
+ "CreateSafetyRuleResponse": {
+ "type": "structure",
+ "members": {
+ "AssertionRule": {
+ "shape": "AssertionRule"
+ },
+ "GatingRule": {
+ "shape": "GatingRule"
+ }
+ }
+ },
+ "DeleteClusterRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ClusterArn"
+ }
+ },
+ "required": [
+ "ClusterArn"
+ ]
+ },
+ "DeleteClusterResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "DeleteControlPanelRequest": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ControlPanelArn"
+ }
+ },
+ "required": [
+ "ControlPanelArn"
+ ]
+ },
+ "DeleteControlPanelResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "DeleteRoutingControlRequest": {
+ "type": "structure",
+ "members": {
+ "RoutingControlArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "RoutingControlArn"
+ }
+ },
+ "required": [
+ "RoutingControlArn"
+ ]
+ },
+ "DeleteRoutingControlResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "DeleteSafetyRuleRequest": {
+ "type": "structure",
+ "members": {
+ "SafetyRuleArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "SafetyRuleArn"
+ }
+ },
+ "required": [
+ "SafetyRuleArn"
+ ]
+ },
+ "DeleteSafetyRuleResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "DescribeClusterRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ClusterArn"
+ }
+ },
+ "required": [
+ "ClusterArn"
+ ]
+ },
+ "DescribeClusterResponse": {
+ "type": "structure",
+ "members": {
+ "Cluster": {
+ "shape": "Cluster"
+ }
+ }
+ },
+ "DescribeControlPanelRequest": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ControlPanelArn"
+ }
+ },
+ "required": [
+ "ControlPanelArn"
+ ]
+ },
+ "DescribeControlPanelResponse": {
+ "type": "structure",
+ "members": {
+ "ControlPanel": {
+ "shape": "ControlPanel"
+ }
+ }
+ },
+ "DescribeRoutingControlRequest": {
+ "type": "structure",
+ "members": {
+ "RoutingControlArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "RoutingControlArn"
+ }
+ },
+ "required": [
+ "RoutingControlArn"
+ ]
+ },
+ "DescribeRoutingControlResponse": {
+ "type": "structure",
+ "members": {
+ "RoutingControl": {
+ "shape": "RoutingControl"
+ }
+ }
+ },
+ "DescribeSafetyRuleRequest": {
+ "type": "structure",
+ "members": {
+ "SafetyRuleArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "SafetyRuleArn"
+ }
+ },
+ "required": [
+ "SafetyRuleArn"
+ ]
+ },
+ "DescribeSafetyRuleResponse": {
+ "type": "structure",
+ "members": {
+ "AssertionRule": {
+ "shape": "AssertionRule"
+ },
+ "GatingRule": {
+ "shape": "GatingRule"
+ }
+ }
+ },
+ "GatingRule": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "GatingControls": {
+ "shape": "__listOf__string"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RuleConfig": {
+ "shape": "RuleConfig"
+ },
+ "SafetyRuleArn": {
+ "shape": "__string"
+ },
+ "Status": {
+ "shape": "Status"
+ },
+ "TargetControls": {
+ "shape": "__listOf__string"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "Status",
+ "TargetControls",
+ "ControlPanelArn",
+ "SafetyRuleArn",
+ "GatingControls",
+ "RuleConfig",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "GatingRuleUpdate": {
+ "type": "structure",
+ "members": {
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "SafetyRuleArn": {
+ "shape": "__string"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "SafetyRuleArn",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "InternalServerException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 500
+ }
+ },
+ "ListAssociatedRoute53HealthChecksRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "MaxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "NextToken"
+ },
+ "RoutingControlArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "RoutingControlArn"
+ }
+ },
+ "required": [
+ "RoutingControlArn"
+ ]
+ },
+ "ListAssociatedRoute53HealthChecksResponse": {
+ "type": "structure",
+ "members": {
+ "HealthCheckIds": {
+ "shape": "__listOf__string"
+ },
+ "NextToken": {
+ "shape": "__stringMax8096"
+ }
+ }
+ },
+ "ListClustersRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "MaxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "NextToken"
+ }
+ }
+ },
+ "ListClustersResponse": {
+ "type": "structure",
+ "members": {
+ "Clusters": {
+ "shape": "__listOfCluster"
+ },
+ "NextToken": {
+ "shape": "__stringMax8096"
+ }
+ }
+ },
+ "ListControlPanelsRequest": {
+ "type": "structure",
+ "members": {
+ "ClusterArn": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "ClusterArn"
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "MaxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "NextToken"
+ }
+ }
+ },
+ "ListControlPanelsResponse": {
+ "type": "structure",
+ "members": {
+ "ControlPanels": {
+ "shape": "__listOfControlPanel"
+ },
+ "NextToken": {
+ "shape": "__stringMax8096"
+ }
+ }
+ },
+ "ListRoutingControlsRequest": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ControlPanelArn"
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "MaxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "NextToken"
+ }
+ },
+ "required": [
+ "ControlPanelArn"
+ ]
+ },
+ "ListRoutingControlsResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__stringMax8096"
+ },
+ "RoutingControls": {
+ "shape": "__listOfRoutingControl"
+ }
+ }
+ },
+ "ListSafetyRulesRequest": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "ControlPanelArn"
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "MaxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "NextToken"
+ }
+ },
+ "required": [
+ "ControlPanelArn"
+ ]
+ },
+ "ListSafetyRulesResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__stringMax8096"
+ },
+ "SafetyRules": {
+ "shape": "__listOfRule"
+ }
+ }
+ },
+ "MaxResults": {
+ "type": "integer",
+ "min": 1,
+ "max": 1000
+ },
+ "NewAssertionRule": {
+ "type": "structure",
+ "members": {
+ "AssertedControls": {
+ "shape": "__listOf__string"
+ },
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RuleConfig": {
+ "shape": "RuleConfig"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "ControlPanelArn",
+ "AssertedControls",
+ "RuleConfig",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "NewGatingRule": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "GatingControls": {
+ "shape": "__listOf__string"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RuleConfig": {
+ "shape": "RuleConfig"
+ },
+ "TargetControls": {
+ "shape": "__listOf__string"
+ },
+ "WaitPeriodMs": {
+ "shape": "__integer"
+ }
+ },
+ "required": [
+ "TargetControls",
+ "ControlPanelArn",
+ "GatingControls",
+ "RuleConfig",
+ "WaitPeriodMs",
+ "Name"
+ ]
+ },
+ "ResourceNotFoundException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 404
+ }
+ },
+ "RoutingControl": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "Name": {
+ "shape": "__stringMin1Max64PatternS"
+ },
+ "RoutingControlArn": {
+ "shape": "__string"
+ },
+ "Status": {
+ "shape": "Status"
+ }
+ }
+ },
+ "Rule": {
+ "type": "structure",
+ "members": {
+ "ASSERTION": {
+ "shape": "AssertionRule"
+ },
+ "GATING": {
+ "shape": "GatingRule"
+ }
+ }
+ },
+ "RuleConfig": {
+ "type": "structure",
+ "members": {
+ "Inverted": {
+ "shape": "__boolean"
+ },
+ "Threshold": {
+ "shape": "__integer"
+ },
+ "Type": {
+ "shape": "RuleType"
+ }
+ },
+ "required": [
+ "Type",
+ "Inverted",
+ "Threshold"
+ ]
+ },
+ "RuleType": {
+ "type": "string",
+ "enum": [
+ "ATLEAST",
+ "AND",
+ "OR"
+ ]
+ },
+ "ServiceQuotaExceededException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 402
+ }
+ },
+ "Status": {
+ "type": "string",
+ "enum": [
+ "PENDING",
+ "DEPLOYED",
+ "PENDING_DELETION"
+ ]
+ },
+ "ThrottlingException": {
+ "type": "structure",
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ },
+ "required": [
+ "Message"
+ ],
+ "exception": true,
+ "error": {
+ "httpStatusCode": 429
+ }
+ },
+ "UpdateControlPanelRequest": {
+ "type": "structure",
+ "members": {
+ "ControlPanelArn": {
+ "shape": "__string"
+ },
+ "ControlPanelName": {
+ "shape": "__stringMin1Max64PatternS"
+ }
+ },
+ "required": [
+ "ControlPanelArn",
+ "ControlPanelName"
+ ]
+ },
+ "UpdateControlPanelResponse": {
+ "type": "structure",
+ "members": {
+ "ControlPanel": {
+ "shape": "ControlPanel"
+ }
+ }
+ },
+ "UpdateRoutingControlRequest": {
+ "type": "structure",
+ "members": {
+ "RoutingControlArn": {
+ "shape": "__string"
+ },
+ "RoutingControlName": {
+ "shape": "__stringMin1Max64PatternS"
+ }
+ },
+ "required": [
+ "RoutingControlName",
+ "RoutingControlArn"
+ ]
+ },
+ "UpdateRoutingControlResponse": {
+ "type": "structure",
+ "members": {
+ "RoutingControl": {
+ "shape": "RoutingControl"
+ }
+ }
+ },
+ "UpdateSafetyRuleRequest": {
+ "type": "structure",
+ "members": {
+ "AssertionRuleUpdate": {
+ "shape": "AssertionRuleUpdate"
+ },
+ "GatingRuleUpdate": {
+ "shape": "GatingRuleUpdate"
+ }
+ }
+ },
+ "UpdateSafetyRuleResponse": {
+ "type": "structure",
+ "members": {
+ "AssertionRule": {
+ "shape": "AssertionRule"
+ },
+ "GatingRule": {
+ "shape": "GatingRule"
+ }
+ }
+ },
+ "ValidationException": {
+ "type": "structure",
+ "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"
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-control-config/2020-11-02/docs-2.json b/models/apis/route53-recovery-control-config/2020-11-02/docs-2.json
new file mode 100644
index 0000000000..79bb96de8d
--- /dev/null
+++ b/models/apis/route53-recovery-control-config/2020-11-02/docs-2.json
@@ -0,0 +1,446 @@
+{
+ "version": "2.0",
+ "service": "Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
",
+ "operations": {
+ "CreateCluster": "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": "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": "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": "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": "Delete a cluster.
",
+ "DeleteControlPanel": "Deletes a control panel.
",
+ "DeleteRoutingControl": "Deletes a routing control.
",
+ "DeleteSafetyRule": "Deletes a safety rule.
/>",
+ "DescribeCluster": "Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
",
+ "DescribeControlPanel": "Displays details about a control panel.
",
+ "DescribeRoutingControl": "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": "Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.
",
+ "ListAssociatedRoute53HealthChecks": "Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
",
+ "ListClusters": "Returns an array of all the clusters in an account.
",
+ "ListControlPanels": "Returns an array of control panels for a cluster.
",
+ "ListRoutingControls": "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": "List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
",
+ "UpdateControlPanel": "Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
",
+ "UpdateRoutingControl": "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": "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": {
+ "base": "403 response - AccessDeniedException. You do not have sufficient access to perform this action.
",
+ "refs": {
+ }
+ },
+ "AssertionRule": {
+ "base": "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.
",
+ "refs": {
+ "CreateSafetyRuleResponse$AssertionRule": null,
+ "DescribeSafetyRuleResponse$AssertionRule": null,
+ "Rule$ASSERTION": "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.
",
+ "UpdateSafetyRuleResponse$AssertionRule": null
+ }
+ },
+ "AssertionRuleUpdate": {
+ "base": "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.
",
+ "refs": {
+ "UpdateSafetyRuleRequest$AssertionRuleUpdate": null
+ }
+ },
+ "Cluster": {
+ "base": "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.
",
+ "refs": {
+ "CreateClusterResponse$Cluster": "The cluster that was created.
",
+ "DescribeClusterResponse$Cluster": "The cluster for the DescribeCluster request.
",
+ "__listOfCluster$member": null
+ }
+ },
+ "ClusterEndpoint": {
+ "base": "A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
",
+ "refs": {
+ "__listOfClusterEndpoint$member": null
+ }
+ },
+ "ConflictException": {
+ "base": "409 response - ConflictException.
",
+ "refs": {
+ }
+ },
+ "ControlPanel": {
+ "base": "A control panel represents a group of routing controls that can be changed together in a single transaction.
",
+ "refs": {
+ "CreateControlPanelResponse$ControlPanel": "Information about a control panel.
",
+ "DescribeControlPanelResponse$ControlPanel": "Information about the control panel.
",
+ "UpdateControlPanelResponse$ControlPanel": "The control panel to update.
",
+ "__listOfControlPanel$member": null
+ }
+ },
+ "CreateClusterRequest": {
+ "base": "The properties of a request to create a cluster.
",
+ "refs": {
+ }
+ },
+ "CreateClusterResponse": {
+ "base": "The result of a successful CreateCluster request.
",
+ "refs": {
+ }
+ },
+ "CreateControlPanelRequest": {
+ "base": "A request to create a control panel.
",
+ "refs": {
+ }
+ },
+ "CreateControlPanelResponse": {
+ "base": "The result of a successful CreateControlPanel request.
",
+ "refs": {
+ }
+ },
+ "CreateRoutingControlRequest": {
+ "base": "A request to create a routing control. If you don't specify ControlPanelArn, Amazon Route 53 Application Recovery Controller creates the routing control in DefaultControlPanel.
",
+ "refs": {
+ }
+ },
+ "CreateRoutingControlResponse": {
+ "base": "The result of a successful CreateRoutingControl request.
",
+ "refs": {
+ }
+ },
+ "CreateSafetyRuleRequest": {
+ "base": "Request to create a safety rule. You can create either an assertion rule or a gating rule with a CreateSafetyRuleRequest call.
",
+ "refs": {
+ }
+ },
+ "CreateSafetyRuleResponse": {
+ "base": "The result of a successful CreateSafetyRule request.
",
+ "refs": {
+ }
+ },
+ "DeleteClusterResponse": {
+ "base": "A successful DeleteCluster request returns no response.
",
+ "refs": {
+ }
+ },
+ "DeleteControlPanelResponse": {
+ "base": "A successful DeleteControlPanel request returns no response.
",
+ "refs": {
+ }
+ },
+ "DeleteRoutingControlResponse": {
+ "base": "A successful DeleteRoutingControl request returns no response.
",
+ "refs": {
+ }
+ },
+ "DeleteSafetyRuleResponse": {
+ "base": "There is an empty response when you delete a safety rule.
/>",
+ "refs": {
+ }
+ },
+ "DescribeClusterResponse": {
+ "base": "The result of a successful DescribeCluster request.
",
+ "refs": {
+ }
+ },
+ "DescribeControlPanelResponse": {
+ "base": "The result of a successful DescribeControlPanel request.
",
+ "refs": {
+ }
+ },
+ "DescribeRoutingControlResponse": {
+ "base": "The result of a successful DescribeRoutingControl request.
",
+ "refs": {
+ }
+ },
+ "DescribeSafetyRuleResponse": {
+ "base": "The response when you send a DescribeSafetyRuleResponse request.
",
+ "refs": {
+ }
+ },
+ "GatingRule": {
+ "base": "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.
",
+ "refs": {
+ "CreateSafetyRuleResponse$GatingRule": null,
+ "DescribeSafetyRuleResponse$GatingRule": null,
+ "Rule$GATING": "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.
",
+ "UpdateSafetyRuleResponse$GatingRule": null
+ }
+ },
+ "GatingRuleUpdate": {
+ "base": "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.
",
+ "refs": {
+ "UpdateSafetyRuleRequest$GatingRuleUpdate": null
+ }
+ },
+ "InternalServerException": {
+ "base": "500 response - InternalServiceError. Temporary service error. Retry the request.
",
+ "refs": {
+ }
+ },
+ "ListAssociatedRoute53HealthChecksResponse": {
+ "base": "The result of a successful ListAssociatedRoute53HealthChecks request.
",
+ "refs": {
+ }
+ },
+ "ListClustersResponse": {
+ "base": "The result of a successful ListClusters request.
",
+ "refs": {
+ }
+ },
+ "ListControlPanelsResponse": {
+ "base": "The result of a successful ListControlPanel request.
",
+ "refs": {
+ }
+ },
+ "ListRoutingControlsResponse": {
+ "base": "The result of a successful ListRoutingControl request.
",
+ "refs": {
+ }
+ },
+ "ListSafetyRulesResponse": {
+ "base": "The response to a ListSafetyRulesRequest.
",
+ "refs": {
+ }
+ },
+ "NewAssertionRule": {
+ "base": "A new assertion rule for a control panel.
",
+ "refs": {
+ "CreateSafetyRuleRequest$AssertionRule": null
+ }
+ },
+ "NewGatingRule": {
+ "base": "A new gating rule for a control panel.
",
+ "refs": {
+ "CreateSafetyRuleRequest$GatingRule": null
+ }
+ },
+ "ResourceNotFoundException": {
+ "base": "404 response - The query string contains a syntax error or resource not found.
",
+ "refs": {
+ }
+ },
+ "RoutingControl": {
+ "base": "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.
",
+ "refs": {
+ "CreateRoutingControlResponse$RoutingControl": "The routing control that is created.
",
+ "DescribeRoutingControlResponse$RoutingControl": "Information about the routing control.
",
+ "UpdateRoutingControlResponse$RoutingControl": "The routing control that was updated.
",
+ "__listOfRoutingControl$member": null
+ }
+ },
+ "Rule": {
+ "base": "A safety rule. A safety rule can be an assertion rule or a gating rule.
",
+ "refs": {
+ "__listOfRule$member": null
+ }
+ },
+ "RuleConfig": {
+ "base": "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.
",
+ "refs": {
+ "AssertionRule$RuleConfig": "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.
",
+ "GatingRule$RuleConfig": "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.
",
+ "NewAssertionRule$RuleConfig": "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.
",
+ "NewGatingRule$RuleConfig": "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.
"
+ }
+ },
+ "RuleType": {
+ "base": "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.
",
+ "refs": {
+ "RuleConfig$Type": "A rule can be one of the following: ATLEAST, AND, or OR.
"
+ }
+ },
+ "ServiceQuotaExceededException": {
+ "base": "402 response
",
+ "refs": {
+ }
+ },
+ "Status": {
+ "base": "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.
",
+ "refs": {
+ "AssertionRule$Status": "The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
",
+ "Cluster$Status": "Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
",
+ "ControlPanel$Status": "The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
",
+ "GatingRule$Status": "The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
",
+ "RoutingControl$Status": "The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
"
+ }
+ },
+ "ThrottlingException": {
+ "base": "429 response - ThrottlingException.
",
+ "refs": {
+ }
+ },
+ "UpdateControlPanelRequest": {
+ "base": "Updates an existing control panel.
",
+ "refs": {
+ }
+ },
+ "UpdateControlPanelResponse": {
+ "base": "The result of a successful UpdateControlPanel request.
",
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlRequest": {
+ "base": "A request to update a routing control.
",
+ "refs": {
+ }
+ },
+ "UpdateRoutingControlResponse": {
+ "base": "The result of a successful UpdateRoutingControl request.
",
+ "refs": {
+ }
+ },
+ "UpdateSafetyRuleRequest": {
+ "base": "Request to update a safety rule. A safety rule can be an assertion rule or a gating rule.
",
+ "refs": {
+ }
+ },
+ "UpdateSafetyRuleResponse": {
+ "base": "The result of a successful UpdateSafetyRule request.
",
+ "refs": {
+ }
+ },
+ "ValidationException": {
+ "base": "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.
",
+ "refs": {
+ }
+ },
+ "__boolean": {
+ "base": null,
+ "refs": {
+ "ControlPanel$DefaultControlPanel": "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.
",
+ "RuleConfig$Inverted": "Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
"
+ }
+ },
+ "__integer": {
+ "base": null,
+ "refs": {
+ "AssertionRule$WaitPeriodMs": "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.
",
+ "AssertionRuleUpdate$WaitPeriodMs": "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.
",
+ "ControlPanel$RoutingControlCount": "The number of routing controls in the control panel.
",
+ "GatingRule$WaitPeriodMs": "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.
",
+ "GatingRuleUpdate$WaitPeriodMs": "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.
",
+ "NewAssertionRule$WaitPeriodMs": "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.
",
+ "NewGatingRule$WaitPeriodMs": "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.
",
+ "RuleConfig$Threshold": "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.
"
+ }
+ },
+ "__listOfCluster": {
+ "base": null,
+ "refs": {
+ "ListClustersResponse$Clusters": "An array of the clusters in an account.
"
+ }
+ },
+ "__listOfClusterEndpoint": {
+ "base": null,
+ "refs": {
+ "Cluster$ClusterEndpoints": "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.
"
+ }
+ },
+ "__listOfControlPanel": {
+ "base": null,
+ "refs": {
+ "ListControlPanelsResponse$ControlPanels": "The result of a successful ListControlPanel request.
"
+ }
+ },
+ "__listOfRoutingControl": {
+ "base": null,
+ "refs": {
+ "ListRoutingControlsResponse$RoutingControls": "An array of routing controls.
"
+ }
+ },
+ "__listOfRule": {
+ "base": null,
+ "refs": {
+ "ListSafetyRulesResponse$SafetyRules": "The list of safety rules in a control panel.
"
+ }
+ },
+ "__listOf__string": {
+ "base": null,
+ "refs": {
+ "AssertionRule$AssertedControls": "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.
",
+ "GatingRule$GatingControls": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
",
+ "GatingRule$TargetControls": "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.
",
+ "ListAssociatedRoute53HealthChecksResponse$HealthCheckIds": "Identifiers for the health checks.
",
+ "NewAssertionRule$AssertedControls": "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.
",
+ "NewGatingRule$GatingControls": "The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
",
+ "NewGatingRule$TargetControls": "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.
"
+ }
+ },
+ "__string": {
+ "base": null,
+ "refs": {
+ "AccessDeniedException$Message": null,
+ "AssertionRule$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel.
",
+ "AssertionRule$SafetyRuleArn": "The Amazon Resource Name (ARN) of the assertion rule.
",
+ "AssertionRuleUpdate$SafetyRuleArn": "The Amazon Resource Name (ARN) of the assertion rule.
",
+ "Cluster$ClusterArn": "The Amazon Resource Name (ARN) of the cluster.
",
+ "ConflictException$Message": null,
+ "ControlPanel$ClusterArn": "The Amazon Resource Name (ARN) of the cluster that includes the control panel.
",
+ "ControlPanel$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel.
",
+ "CreateControlPanelRequest$ClusterArn": "The Amazon Resource Name (ARN) of the cluster for the control panel.
",
+ "CreateRoutingControlRequest$ClusterArn": "The Amazon Resource Name (ARN) of the cluster that includes the routing control.
",
+ "CreateRoutingControlRequest$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
",
+ "GatingRule$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel.
",
+ "GatingRule$SafetyRuleArn": "The Amazon Resource Name (ARN) of the gating rule.
",
+ "GatingRuleUpdate$SafetyRuleArn": "The Amazon Resource Name (ARN) of the gating rule.
",
+ "InternalServerException$Message": null,
+ "NewAssertionRule$ControlPanelArn": "The Amazon Resource Name (ARN) for the control panel.
",
+ "NewGatingRule$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel.
",
+ "ResourceNotFoundException$Message": null,
+ "RoutingControl$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
",
+ "RoutingControl$RoutingControlArn": "The Amazon Resource Name (ARN) of the routing control.
",
+ "ServiceQuotaExceededException$Message": null,
+ "ThrottlingException$Message": null,
+ "UpdateControlPanelRequest$ControlPanelArn": "The Amazon Resource Name (ARN) of the control panel.
",
+ "UpdateRoutingControlRequest$RoutingControlArn": "The Amazon Resource Name (ARN) of the routing control.
",
+ "ValidationException$Message": null,
+ "__listOf__string$member": null
+ }
+ },
+ "__stringMax64": {
+ "base": null,
+ "refs": {
+ "CreateClusterRequest$ClientToken": "Unique client idempotency token.
",
+ "CreateControlPanelRequest$ClientToken": "Unique client idempotency token.
",
+ "CreateRoutingControlRequest$ClientToken": "Unique client idempotency token.
",
+ "CreateSafetyRuleRequest$ClientToken": "Unique client idempotency token.
"
+ }
+ },
+ "__stringMax8096": {
+ "base": null,
+ "refs": {
+ "ListAssociatedRoute53HealthChecksResponse$NextToken": "The token that identifies which batch of results you want to see.
",
+ "ListClustersResponse$NextToken": "The token that identifies which batch of results you want to see.
",
+ "ListControlPanelsResponse$NextToken": "The token that identifies which batch of results you want to see.
",
+ "ListRoutingControlsResponse$NextToken": "The token that identifies which batch of results you want to see.
",
+ "ListSafetyRulesResponse$NextToken": "The token that identifies which batch of results you want to see.
"
+ }
+ },
+ "__stringMin1Max128": {
+ "base": null,
+ "refs": {
+ "ClusterEndpoint$Endpoint": "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.
"
+ }
+ },
+ "__stringMin1Max32": {
+ "base": null,
+ "refs": {
+ "ClusterEndpoint$Region": "The Amazon Web Services Region for a cluster endpoint.
"
+ }
+ },
+ "__stringMin1Max64PatternS": {
+ "base": null,
+ "refs": {
+ "AssertionRule$Name": "Name of the assertion rule. You can use any non-white space character in the name.
",
+ "AssertionRuleUpdate$Name": "The name of the assertion rule. You can use any non-white space character in the name.
",
+ "Cluster$Name": "The name of the cluster.
",
+ "ControlPanel$Name": "The name of the control panel. You can use any non-white space character in the name.
",
+ "CreateClusterRequest$ClusterName": "The name of the cluster.
",
+ "CreateControlPanelRequest$ControlPanelName": "The name of the control panel.
",
+ "CreateRoutingControlRequest$RoutingControlName": "The name of the routing control.
",
+ "GatingRule$Name": "The name for the gating rule.
",
+ "GatingRuleUpdate$Name": "The name for the gating rule.
",
+ "NewAssertionRule$Name": "The name of the assertion rule. You can use any non-white space character in the name.
",
+ "NewGatingRule$Name": "The name for the new gating rule.
",
+ "RoutingControl$Name": "The name of the routing control.
",
+ "UpdateControlPanelRequest$ControlPanelName": "The name of the control panel.
",
+ "UpdateRoutingControlRequest$RoutingControlName": "The name of the routing control.
"
+ }
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-control-config/2020-11-02/paginators-1.json b/models/apis/route53-recovery-control-config/2020-11-02/paginators-1.json
new file mode 100644
index 0000000000..d5c61731ad
--- /dev/null
+++ b/models/apis/route53-recovery-control-config/2020-11-02/paginators-1.json
@@ -0,0 +1,29 @@
+{
+ "pagination" : {
+ "ListAssociatedRoute53HealthChecks" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults"
+ },
+ "ListClusters" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults"
+ },
+ "ListControlPanels" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults"
+ },
+ "ListRoutingControls" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults"
+ },
+ "ListSafetyRules" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults"
+ }
+ }
+}
\ No newline at end of file
diff --git a/models/apis/route53-recovery-control-config/2020-11-02/waiters-2.json b/models/apis/route53-recovery-control-config/2020-11-02/waiters-2.json
new file mode 100644
index 0000000000..1794757e6d
--- /dev/null
+++ b/models/apis/route53-recovery-control-config/2020-11-02/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
+ }
+ ]
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-readiness/2019-12-02/api-2.json b/models/apis/route53-recovery-readiness/2019-12-02/api-2.json
new file mode 100644
index 0000000000..0dfb8fa3a1
--- /dev/null
+++ b/models/apis/route53-recovery-readiness/2019-12-02/api-2.json
@@ -0,0 +1,2495 @@
+{
+ "metadata": {
+ "apiVersion": "2019-12-02",
+ "endpointPrefix": "route53-recovery-readiness",
+ "signingName": "route53-recovery-readiness",
+ "serviceFullName": "AWS Route53 Recovery Readiness",
+ "serviceId": "Route53 Recovery Readiness",
+ "protocol": "rest-json",
+ "jsonVersion": "1.1",
+ "uid": "route53-recovery-readiness-2019-12-02",
+ "signatureVersion": "v4"
+ },
+ "operations": {
+ "CreateCell": {
+ "name": "CreateCell",
+ "http": {
+ "method": "POST",
+ "requestUri": "/cells",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateCellRequest"
+ },
+ "output": {
+ "shape": "CreateCellResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ConflictException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "CreateCrossAccountAuthorization": {
+ "name": "CreateCrossAccountAuthorization",
+ "http": {
+ "method": "POST",
+ "requestUri": "/crossaccountauthorizations",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateCrossAccountAuthorizationRequest"
+ },
+ "output": {
+ "shape": "CreateCrossAccountAuthorizationResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ConflictException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "CreateReadinessCheck": {
+ "name": "CreateReadinessCheck",
+ "http": {
+ "method": "POST",
+ "requestUri": "/readinesschecks",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateReadinessCheckRequest"
+ },
+ "output": {
+ "shape": "CreateReadinessCheckResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ConflictException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "CreateRecoveryGroup": {
+ "name": "CreateRecoveryGroup",
+ "http": {
+ "method": "POST",
+ "requestUri": "/recoverygroups",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateRecoveryGroupRequest"
+ },
+ "output": {
+ "shape": "CreateRecoveryGroupResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ConflictException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "CreateResourceSet": {
+ "name": "CreateResourceSet",
+ "http": {
+ "method": "POST",
+ "requestUri": "/resourcesets",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "CreateResourceSetRequest"
+ },
+ "output": {
+ "shape": "CreateResourceSetResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "ConflictException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "DeleteCell": {
+ "name": "DeleteCell",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/cells/{cellName}",
+ "responseCode": 204
+ },
+ "input": {
+ "shape": "DeleteCellRequest"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "DeleteCrossAccountAuthorization": {
+ "name": "DeleteCrossAccountAuthorization",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/crossaccountauthorizations/{crossAccountAuthorization}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "DeleteCrossAccountAuthorizationRequest"
+ },
+ "output": {
+ "shape": "DeleteCrossAccountAuthorizationResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "DeleteReadinessCheck": {
+ "name": "DeleteReadinessCheck",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/readinesschecks/{readinessCheckName}",
+ "responseCode": 204
+ },
+ "input": {
+ "shape": "DeleteReadinessCheckRequest"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "DeleteRecoveryGroup": {
+ "name": "DeleteRecoveryGroup",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/recoverygroups/{recoveryGroupName}",
+ "responseCode": 204
+ },
+ "input": {
+ "shape": "DeleteRecoveryGroupRequest"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "DeleteResourceSet": {
+ "name": "DeleteResourceSet",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/resourcesets/{resourceSetName}",
+ "responseCode": 204
+ },
+ "input": {
+ "shape": "DeleteResourceSetRequest"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetArchitectureRecommendations": {
+ "name": "GetArchitectureRecommendations",
+ "http": {
+ "method": "GET",
+ "requestUri": "/recoverygroups/{recoveryGroupName}/architectureRecommendations",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetArchitectureRecommendationsRequest"
+ },
+ "output": {
+ "shape": "GetArchitectureRecommendationsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetCell": {
+ "name": "GetCell",
+ "http": {
+ "method": "GET",
+ "requestUri": "/cells/{cellName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetCellRequest"
+ },
+ "output": {
+ "shape": "GetCellResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetCellReadinessSummary": {
+ "name": "GetCellReadinessSummary",
+ "http": {
+ "method": "GET",
+ "requestUri": "/cellreadiness/{cellName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetCellReadinessSummaryRequest"
+ },
+ "output": {
+ "shape": "GetCellReadinessSummaryResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetReadinessCheck": {
+ "name": "GetReadinessCheck",
+ "http": {
+ "method": "GET",
+ "requestUri": "/readinesschecks/{readinessCheckName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetReadinessCheckRequest"
+ },
+ "output": {
+ "shape": "GetReadinessCheckResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetReadinessCheckResourceStatus": {
+ "name": "GetReadinessCheckResourceStatus",
+ "http": {
+ "method": "GET",
+ "requestUri": "/readinesschecks/{readinessCheckName}/resource/{resourceIdentifier}/status",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetReadinessCheckResourceStatusRequest"
+ },
+ "output": {
+ "shape": "GetReadinessCheckResourceStatusResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetReadinessCheckStatus": {
+ "name": "GetReadinessCheckStatus",
+ "http": {
+ "method": "GET",
+ "requestUri": "/readinesschecks/{readinessCheckName}/status",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetReadinessCheckStatusRequest"
+ },
+ "output": {
+ "shape": "GetReadinessCheckStatusResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetRecoveryGroup": {
+ "name": "GetRecoveryGroup",
+ "http": {
+ "method": "GET",
+ "requestUri": "/recoverygroups/{recoveryGroupName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetRecoveryGroupRequest"
+ },
+ "output": {
+ "shape": "GetRecoveryGroupResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetRecoveryGroupReadinessSummary": {
+ "name": "GetRecoveryGroupReadinessSummary",
+ "http": {
+ "method": "GET",
+ "requestUri": "/recoverygroupreadiness/{recoveryGroupName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetRecoveryGroupReadinessSummaryRequest"
+ },
+ "output": {
+ "shape": "GetRecoveryGroupReadinessSummaryResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "GetResourceSet": {
+ "name": "GetResourceSet",
+ "http": {
+ "method": "GET",
+ "requestUri": "/resourcesets/{resourceSetName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "GetResourceSetRequest"
+ },
+ "output": {
+ "shape": "GetResourceSetResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListCells": {
+ "name": "ListCells",
+ "http": {
+ "method": "GET",
+ "requestUri": "/cells",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListCellsRequest"
+ },
+ "output": {
+ "shape": "ListCellsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListCrossAccountAuthorizations": {
+ "name": "ListCrossAccountAuthorizations",
+ "http": {
+ "method": "GET",
+ "requestUri": "/crossaccountauthorizations",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListCrossAccountAuthorizationsRequest"
+ },
+ "output": {
+ "shape": "ListCrossAccountAuthorizationsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListReadinessChecks": {
+ "name": "ListReadinessChecks",
+ "http": {
+ "method": "GET",
+ "requestUri": "/readinesschecks",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListReadinessChecksRequest"
+ },
+ "output": {
+ "shape": "ListReadinessChecksResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListRecoveryGroups": {
+ "name": "ListRecoveryGroups",
+ "http": {
+ "method": "GET",
+ "requestUri": "/recoverygroups",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListRecoveryGroupsRequest"
+ },
+ "output": {
+ "shape": "ListRecoveryGroupsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListResourceSets": {
+ "name": "ListResourceSets",
+ "http": {
+ "method": "GET",
+ "requestUri": "/resourcesets",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListResourceSetsRequest"
+ },
+ "output": {
+ "shape": "ListResourceSetsResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListRules": {
+ "name": "ListRules",
+ "http": {
+ "method": "GET",
+ "requestUri": "/rules",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListRulesRequest"
+ },
+ "output": {
+ "shape": "ListRulesResponse"
+ },
+ "errors": [
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "ListTagsForResources": {
+ "name": "ListTagsForResources",
+ "http": {
+ "method": "GET",
+ "requestUri": "/tags/{resource-arn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "ListTagsForResourcesRequest"
+ },
+ "output": {
+ "shape": "ListTagsForResourcesResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "TagResource": {
+ "name": "TagResource",
+ "http": {
+ "method": "POST",
+ "requestUri": "/tags/{resource-arn}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "TagResourceRequest"
+ },
+ "output": {
+ "shape": "TagResourceResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "UntagResource": {
+ "name": "UntagResource",
+ "http": {
+ "method": "DELETE",
+ "requestUri": "/tags/{resource-arn}",
+ "responseCode": 204
+ },
+ "input": {
+ "shape": "UntagResourceRequest"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ }
+ ]
+ },
+ "UpdateCell": {
+ "name": "UpdateCell",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/cells/{cellName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateCellRequest"
+ },
+ "output": {
+ "shape": "UpdateCellResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "UpdateReadinessCheck": {
+ "name": "UpdateReadinessCheck",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/readinesschecks/{readinessCheckName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateReadinessCheckRequest"
+ },
+ "output": {
+ "shape": "UpdateReadinessCheckResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "UpdateRecoveryGroup": {
+ "name": "UpdateRecoveryGroup",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/recoverygroups/{recoveryGroupName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateRecoveryGroupRequest"
+ },
+ "output": {
+ "shape": "UpdateRecoveryGroupResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ },
+ "UpdateResourceSet": {
+ "name": "UpdateResourceSet",
+ "http": {
+ "method": "PUT",
+ "requestUri": "/resourcesets/{resourceSetName}",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "UpdateResourceSetRequest"
+ },
+ "output": {
+ "shape": "UpdateResourceSetResponse"
+ },
+ "errors": [
+ {
+ "shape": "ResourceNotFoundException"
+ },
+ {
+ "shape": "ThrottlingException"
+ },
+ {
+ "shape": "ValidationException"
+ },
+ {
+ "shape": "InternalServerException"
+ },
+ {
+ "shape": "AccessDeniedException"
+ }
+ ]
+ }
+ },
+ "shapes": {
+ "AccessDeniedException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 403
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "CellOutput": {
+ "type": "structure",
+ "members": {
+ "CellArn": {
+ "shape": "__stringMax256",
+ "locationName": "cellArn"
+ },
+ "CellName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "ParentReadinessScopes": {
+ "shape": "__listOf__string",
+ "locationName": "parentReadinessScopes"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ParentReadinessScopes",
+ "CellArn",
+ "CellName",
+ "Cells"
+ ]
+ },
+ "ConflictException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 409
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "CreateCellRequest": {
+ "type": "structure",
+ "members": {
+ "CellName": {
+ "shape": "__string",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "CellName"
+ ]
+ },
+ "CreateCellResponse": {
+ "type": "structure",
+ "members": {
+ "CellArn": {
+ "shape": "__stringMax256",
+ "locationName": "cellArn"
+ },
+ "CellName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "ParentReadinessScopes": {
+ "shape": "__listOf__string",
+ "locationName": "parentReadinessScopes"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "CreateCrossAccountAuthorizationRequest": {
+ "type": "structure",
+ "members": {
+ "CrossAccountAuthorization": {
+ "shape": "CrossAccountAuthorization",
+ "locationName": "crossAccountAuthorization"
+ }
+ },
+ "required": [
+ "CrossAccountAuthorization"
+ ]
+ },
+ "CreateCrossAccountAuthorizationResponse": {
+ "type": "structure",
+ "members": {
+ "CrossAccountAuthorization": {
+ "shape": "CrossAccountAuthorization",
+ "locationName": "crossAccountAuthorization"
+ }
+ }
+ },
+ "CreateReadinessCheckRequest": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSetName": {
+ "shape": "__string",
+ "locationName": "resourceSetName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ResourceSetName",
+ "ReadinessCheckName"
+ ]
+ },
+ "CreateReadinessCheckResponse": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckArn": {
+ "shape": "__stringMax256",
+ "locationName": "readinessCheckArn"
+ },
+ "ReadinessCheckName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSet": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSet"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "CreateRecoveryGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "locationName": "recoveryGroupName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "RecoveryGroupName"
+ ]
+ },
+ "CreateRecoveryGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupArn": {
+ "shape": "__stringMax256",
+ "locationName": "recoveryGroupArn"
+ },
+ "RecoveryGroupName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "recoveryGroupName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "CreateResourceSetRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceSetName": {
+ "shape": "__string",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ResourceSetType",
+ "ResourceSetName",
+ "Resources"
+ ]
+ },
+ "CreateResourceSetResponse": {
+ "type": "structure",
+ "members": {
+ "ResourceSetArn": {
+ "shape": "__stringMax256",
+ "locationName": "resourceSetArn"
+ },
+ "ResourceSetName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "CrossAccountAuthorization": {
+ "type": "string"
+ },
+ "DNSTargetResource": {
+ "type": "structure",
+ "members": {
+ "DomainName": {
+ "shape": "__string",
+ "locationName": "domainName"
+ },
+ "HostedZoneArn": {
+ "shape": "__string",
+ "locationName": "hostedZoneArn"
+ },
+ "RecordSetId": {
+ "shape": "__string",
+ "locationName": "recordSetId"
+ },
+ "RecordType": {
+ "shape": "__string",
+ "locationName": "recordType"
+ },
+ "TargetResource": {
+ "shape": "TargetResource",
+ "locationName": "targetResource"
+ }
+ }
+ },
+ "DeleteCellRequest": {
+ "type": "structure",
+ "members": {
+ "CellName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "cellName"
+ }
+ },
+ "required": [
+ "CellName"
+ ]
+ },
+ "DeleteCrossAccountAuthorizationRequest": {
+ "type": "structure",
+ "members": {
+ "CrossAccountAuthorization": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "crossAccountAuthorization"
+ }
+ },
+ "required": [
+ "CrossAccountAuthorization"
+ ]
+ },
+ "DeleteCrossAccountAuthorizationResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "DeleteReadinessCheckRequest": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "readinessCheckName"
+ }
+ },
+ "required": [
+ "ReadinessCheckName"
+ ]
+ },
+ "DeleteRecoveryGroupRequest": {
+ "type": "structure",
+ "members": {
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "recoveryGroupName"
+ }
+ },
+ "required": [
+ "RecoveryGroupName"
+ ]
+ },
+ "DeleteResourceSetRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceSetName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resourceSetName"
+ }
+ },
+ "required": [
+ "ResourceSetName"
+ ]
+ },
+ "GetArchitectureRecommendationsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "recoveryGroupName"
+ }
+ },
+ "required": [
+ "RecoveryGroupName"
+ ]
+ },
+ "GetArchitectureRecommendationsResponse": {
+ "type": "structure",
+ "members": {
+ "LastAuditTimestamp": {
+ "shape": "LastAuditTimestamp",
+ "locationName": "lastAuditTimestamp"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Recommendations": {
+ "shape": "__listOfRecommendation",
+ "locationName": "recommendations"
+ }
+ }
+ },
+ "GetCellReadinessSummaryRequest": {
+ "type": "structure",
+ "members": {
+ "CellName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "cellName"
+ },
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ },
+ "required": [
+ "CellName"
+ ]
+ },
+ "GetCellReadinessSummaryResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "ReadinessChecks": {
+ "shape": "__listOfReadinessCheckSummary",
+ "locationName": "readinessChecks"
+ }
+ }
+ },
+ "GetCellRequest": {
+ "type": "structure",
+ "members": {
+ "CellName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "cellName"
+ }
+ },
+ "required": [
+ "CellName"
+ ]
+ },
+ "GetCellResponse": {
+ "type": "structure",
+ "members": {
+ "CellArn": {
+ "shape": "__stringMax256",
+ "locationName": "cellArn"
+ },
+ "CellName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "ParentReadinessScopes": {
+ "shape": "__listOf__string",
+ "locationName": "parentReadinessScopes"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "GetReadinessCheckRequest": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "readinessCheckName"
+ }
+ },
+ "required": [
+ "ReadinessCheckName"
+ ]
+ },
+ "GetReadinessCheckResourceStatusRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceIdentifier": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resourceIdentifier"
+ }
+ },
+ "required": [
+ "ReadinessCheckName",
+ "ResourceIdentifier"
+ ]
+ },
+ "GetReadinessCheckResourceStatusResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "Rules": {
+ "shape": "__listOfRuleResult",
+ "locationName": "rules"
+ }
+ }
+ },
+ "GetReadinessCheckResponse": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckArn": {
+ "shape": "__stringMax256",
+ "locationName": "readinessCheckArn"
+ },
+ "ReadinessCheckName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSet": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSet"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "GetReadinessCheckStatusRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "readinessCheckName"
+ }
+ },
+ "required": [
+ "ReadinessCheckName"
+ ]
+ },
+ "GetReadinessCheckStatusResponse": {
+ "type": "structure",
+ "members": {
+ "Messages": {
+ "shape": "__listOfMessage",
+ "locationName": "messages"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "Resources": {
+ "shape": "__listOfResourceResult",
+ "locationName": "resources"
+ }
+ }
+ },
+ "GetRecoveryGroupReadinessSummaryRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "recoveryGroupName"
+ }
+ },
+ "required": [
+ "RecoveryGroupName"
+ ]
+ },
+ "GetRecoveryGroupReadinessSummaryResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "ReadinessChecks": {
+ "shape": "__listOfReadinessCheckSummary",
+ "locationName": "readinessChecks"
+ }
+ }
+ },
+ "GetRecoveryGroupRequest": {
+ "type": "structure",
+ "members": {
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "recoveryGroupName"
+ }
+ },
+ "required": [
+ "RecoveryGroupName"
+ ]
+ },
+ "GetRecoveryGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupArn": {
+ "shape": "__stringMax256",
+ "locationName": "recoveryGroupArn"
+ },
+ "RecoveryGroupName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "recoveryGroupName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "GetResourceSetRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceSetName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resourceSetName"
+ }
+ },
+ "required": [
+ "ResourceSetName"
+ ]
+ },
+ "GetResourceSetResponse": {
+ "type": "structure",
+ "members": {
+ "ResourceSetArn": {
+ "shape": "__stringMax256",
+ "locationName": "resourceSetArn"
+ },
+ "ResourceSetName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "InternalServerException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 500
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "LastAuditTimestamp": {
+ "type": "timestamp",
+ "timestampFormat": "iso8601"
+ },
+ "ListCellsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListCellsResponse": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOfCellOutput",
+ "locationName": "cells"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListCrossAccountAuthorizationsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListCrossAccountAuthorizationsResponse": {
+ "type": "structure",
+ "members": {
+ "CrossAccountAuthorizations": {
+ "shape": "__listOfCrossAccountAuthorization",
+ "locationName": "crossAccountAuthorizations"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListReadinessChecksRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListReadinessChecksResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "ReadinessChecks": {
+ "shape": "__listOfReadinessCheckOutput",
+ "locationName": "readinessChecks"
+ }
+ }
+ },
+ "ListRecoveryGroupsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListRecoveryGroupsResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "RecoveryGroups": {
+ "shape": "__listOfRecoveryGroupOutput",
+ "locationName": "recoveryGroups"
+ }
+ }
+ },
+ "ListResourceSetsRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ }
+ }
+ },
+ "ListResourceSetsResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "ResourceSets": {
+ "shape": "__listOfResourceSetOutput",
+ "locationName": "resourceSets"
+ }
+ }
+ },
+ "ListRulesOutput": {
+ "type": "structure",
+ "members": {
+ "ResourceType": {
+ "shape": "__stringMax64",
+ "locationName": "resourceType"
+ },
+ "RuleDescription": {
+ "shape": "__stringMax256",
+ "locationName": "ruleDescription"
+ },
+ "RuleId": {
+ "shape": "__stringMax64",
+ "locationName": "ruleId"
+ }
+ },
+ "required": [
+ "RuleDescription",
+ "RuleId",
+ "ResourceType"
+ ]
+ },
+ "ListRulesRequest": {
+ "type": "structure",
+ "members": {
+ "MaxResults": {
+ "shape": "MaxResults",
+ "location": "querystring",
+ "locationName": "maxResults"
+ },
+ "NextToken": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "nextToken"
+ },
+ "ResourceType": {
+ "shape": "__string",
+ "location": "querystring",
+ "locationName": "resourceType"
+ }
+ }
+ },
+ "ListRulesResponse": {
+ "type": "structure",
+ "members": {
+ "NextToken": {
+ "shape": "__string",
+ "locationName": "nextToken"
+ },
+ "Rules": {
+ "shape": "__listOfListRulesOutput",
+ "locationName": "rules"
+ }
+ }
+ },
+ "ListTagsForResourcesRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resource-arn"
+ }
+ },
+ "required": [
+ "ResourceArn"
+ ]
+ },
+ "ListTagsForResourcesResponse": {
+ "type": "structure",
+ "members": {
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "MaxResults": {
+ "type": "integer",
+ "min": 1,
+ "max": 1000
+ },
+ "Message": {
+ "type": "structure",
+ "members": {
+ "MessageText": {
+ "shape": "__string",
+ "locationName": "messageText"
+ }
+ }
+ },
+ "NLBResource": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "__string",
+ "locationName": "arn"
+ }
+ }
+ },
+ "R53ResourceRecord": {
+ "type": "structure",
+ "members": {
+ "DomainName": {
+ "shape": "__string",
+ "locationName": "domainName"
+ },
+ "RecordSetId": {
+ "shape": "__string",
+ "locationName": "recordSetId"
+ }
+ }
+ },
+ "Readiness": {
+ "type": "string",
+ "enum": [
+ "READY",
+ "NOT_READY",
+ "UNKNOWN",
+ "NOT_AUTHORIZED"
+ ]
+ },
+ "ReadinessCheckOutput": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckArn": {
+ "shape": "__stringMax256",
+ "locationName": "readinessCheckArn"
+ },
+ "ReadinessCheckName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSet": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSet"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ReadinessCheckArn",
+ "ResourceSet"
+ ]
+ },
+ "ReadinessCheckSummary": {
+ "type": "structure",
+ "members": {
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "locationName": "readinessCheckName"
+ }
+ }
+ },
+ "ReadinessCheckTimestamp": {
+ "type": "timestamp",
+ "timestampFormat": "iso8601"
+ },
+ "Recommendation": {
+ "type": "structure",
+ "members": {
+ "RecommendationText": {
+ "shape": "__string",
+ "locationName": "recommendationText"
+ }
+ },
+ "required": [
+ "RecommendationText"
+ ]
+ },
+ "RecoveryGroupOutput": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupArn": {
+ "shape": "__stringMax256",
+ "locationName": "recoveryGroupArn"
+ },
+ "RecoveryGroupName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "recoveryGroupName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "RecoveryGroupArn",
+ "RecoveryGroupName",
+ "Cells"
+ ]
+ },
+ "Resource": {
+ "type": "structure",
+ "members": {
+ "ComponentId": {
+ "shape": "__string",
+ "locationName": "componentId"
+ },
+ "DnsTargetResource": {
+ "shape": "DNSTargetResource",
+ "locationName": "dnsTargetResource"
+ },
+ "ReadinessScopes": {
+ "shape": "__listOf__string",
+ "locationName": "readinessScopes"
+ },
+ "ResourceArn": {
+ "shape": "__string",
+ "locationName": "resourceArn"
+ }
+ }
+ },
+ "ResourceNotFoundException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 404
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "ResourceResult": {
+ "type": "structure",
+ "members": {
+ "ComponentId": {
+ "shape": "__string",
+ "locationName": "componentId"
+ },
+ "LastCheckedTimestamp": {
+ "shape": "ReadinessCheckTimestamp",
+ "locationName": "lastCheckedTimestamp"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "ResourceArn": {
+ "shape": "__string",
+ "locationName": "resourceArn"
+ }
+ },
+ "required": [
+ "Readiness",
+ "LastCheckedTimestamp"
+ ]
+ },
+ "ResourceSetOutput": {
+ "type": "structure",
+ "members": {
+ "ResourceSetArn": {
+ "shape": "__stringMax256",
+ "locationName": "resourceSetArn"
+ },
+ "ResourceSetName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ResourceSetType",
+ "ResourceSetName",
+ "ResourceSetArn",
+ "Resources"
+ ]
+ },
+ "RuleResult": {
+ "type": "structure",
+ "members": {
+ "LastCheckedTimestamp": {
+ "shape": "ReadinessCheckTimestamp",
+ "locationName": "lastCheckedTimestamp"
+ },
+ "Messages": {
+ "shape": "__listOfMessage",
+ "locationName": "messages"
+ },
+ "Readiness": {
+ "shape": "Readiness",
+ "locationName": "readiness"
+ },
+ "RuleId": {
+ "shape": "__string",
+ "locationName": "ruleId"
+ }
+ },
+ "required": [
+ "Messages",
+ "Readiness",
+ "RuleId",
+ "LastCheckedTimestamp"
+ ]
+ },
+ "TagResourceRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resource-arn"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ },
+ "required": [
+ "ResourceArn",
+ "Tags"
+ ]
+ },
+ "TagResourceResponse": {
+ "type": "structure",
+ "members": {}
+ },
+ "Tags": {
+ "type": "map",
+ "key": {
+ "shape": "__string"
+ },
+ "value": {
+ "shape": "__string"
+ }
+ },
+ "TargetResource": {
+ "type": "structure",
+ "members": {
+ "NLBResource": {
+ "shape": "NLBResource",
+ "locationName": "nLBResource"
+ },
+ "R53Resource": {
+ "shape": "R53ResourceRecord",
+ "locationName": "r53Resource"
+ }
+ }
+ },
+ "ThrottlingException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 429
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "UntagResourceRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceArn": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resource-arn"
+ },
+ "TagKeys": {
+ "shape": "__listOf__string",
+ "location": "querystring",
+ "locationName": "tagKeys"
+ }
+ },
+ "required": [
+ "TagKeys",
+ "ResourceArn"
+ ]
+ },
+ "UpdateCellRequest": {
+ "type": "structure",
+ "members": {
+ "CellName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ }
+ },
+ "required": [
+ "CellName",
+ "Cells"
+ ]
+ },
+ "UpdateCellResponse": {
+ "type": "structure",
+ "members": {
+ "CellArn": {
+ "shape": "__stringMax256",
+ "locationName": "cellArn"
+ },
+ "CellName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "cellName"
+ },
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "ParentReadinessScopes": {
+ "shape": "__listOf__string",
+ "locationName": "parentReadinessScopes"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "UpdateReadinessCheckRequest": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSetName": {
+ "shape": "__string",
+ "locationName": "resourceSetName"
+ }
+ },
+ "required": [
+ "ReadinessCheckName",
+ "ResourceSetName"
+ ]
+ },
+ "UpdateReadinessCheckResponse": {
+ "type": "structure",
+ "members": {
+ "ReadinessCheckArn": {
+ "shape": "__stringMax256",
+ "locationName": "readinessCheckArn"
+ },
+ "ReadinessCheckName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "readinessCheckName"
+ },
+ "ResourceSet": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSet"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "UpdateRecoveryGroupRequest": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "recoveryGroupName"
+ }
+ },
+ "required": [
+ "RecoveryGroupName",
+ "Cells"
+ ]
+ },
+ "UpdateRecoveryGroupResponse": {
+ "type": "structure",
+ "members": {
+ "Cells": {
+ "shape": "__listOf__string",
+ "locationName": "cells"
+ },
+ "RecoveryGroupArn": {
+ "shape": "__stringMax256",
+ "locationName": "recoveryGroupArn"
+ },
+ "RecoveryGroupName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "recoveryGroupName"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "UpdateResourceSetRequest": {
+ "type": "structure",
+ "members": {
+ "ResourceSetName": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ }
+ },
+ "required": [
+ "ResourceSetName",
+ "ResourceSetType",
+ "Resources"
+ ]
+ },
+ "UpdateResourceSetResponse": {
+ "type": "structure",
+ "members": {
+ "ResourceSetArn": {
+ "shape": "__stringMax256",
+ "locationName": "resourceSetArn"
+ },
+ "ResourceSetName": {
+ "shape": "__stringMax64PatternAAZAZ09Z",
+ "locationName": "resourceSetName"
+ },
+ "ResourceSetType": {
+ "shape": "__stringPatternAWSAZaZ09AZaZ09",
+ "locationName": "resourceSetType"
+ },
+ "Resources": {
+ "shape": "__listOfResource",
+ "locationName": "resources"
+ },
+ "Tags": {
+ "shape": "Tags",
+ "locationName": "tags"
+ }
+ }
+ },
+ "ValidationException": {
+ "type": "structure",
+ "exception": true,
+ "error": {
+ "httpStatusCode": 400
+ },
+ "members": {
+ "Message": {
+ "shape": "__string",
+ "locationName": "message"
+ }
+ }
+ },
+ "__listOfCellOutput": {
+ "type": "list",
+ "member": {
+ "shape": "CellOutput"
+ }
+ },
+ "__listOfCrossAccountAuthorization": {
+ "type": "list",
+ "member": {
+ "shape": "CrossAccountAuthorization"
+ }
+ },
+ "__listOfListRulesOutput": {
+ "type": "list",
+ "member": {
+ "shape": "ListRulesOutput"
+ }
+ },
+ "__listOfMessage": {
+ "type": "list",
+ "member": {
+ "shape": "Message"
+ }
+ },
+ "__listOfReadinessCheckOutput": {
+ "type": "list",
+ "member": {
+ "shape": "ReadinessCheckOutput"
+ }
+ },
+ "__listOfReadinessCheckSummary": {
+ "type": "list",
+ "member": {
+ "shape": "ReadinessCheckSummary"
+ }
+ },
+ "__listOfRecommendation": {
+ "type": "list",
+ "member": {
+ "shape": "Recommendation"
+ }
+ },
+ "__listOfRecoveryGroupOutput": {
+ "type": "list",
+ "member": {
+ "shape": "RecoveryGroupOutput"
+ }
+ },
+ "__listOfResource": {
+ "type": "list",
+ "member": {
+ "shape": "Resource"
+ }
+ },
+ "__listOfResourceResult": {
+ "type": "list",
+ "member": {
+ "shape": "ResourceResult"
+ }
+ },
+ "__listOfResourceSetOutput": {
+ "type": "list",
+ "member": {
+ "shape": "ResourceSetOutput"
+ }
+ },
+ "__listOfRuleResult": {
+ "type": "list",
+ "member": {
+ "shape": "RuleResult"
+ }
+ },
+ "__listOf__string": {
+ "type": "list",
+ "member": {
+ "shape": "__string"
+ }
+ },
+ "__string": {
+ "type": "string"
+ },
+ "__stringMax256": {
+ "type": "string",
+ "max": 256
+ },
+ "__stringMax64": {
+ "type": "string",
+ "max": 64
+ },
+ "__stringMax64PatternAAZAZ09Z": {
+ "type": "string",
+ "max": 64,
+ "pattern": "\\A[a-zA-Z0-9_]+\\z"
+ },
+ "__stringPatternAWSAZaZ09AZaZ09": {
+ "type": "string",
+ "pattern": "AWS::[A-Za-z0-9]+::[A-Za-z0-9]+"
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-readiness/2019-12-02/docs-2.json b/models/apis/route53-recovery-readiness/2019-12-02/docs-2.json
new file mode 100644
index 0000000000..b97eb738c2
--- /dev/null
+++ b/models/apis/route53-recovery-readiness/2019-12-02/docs-2.json
@@ -0,0 +1,432 @@
+{
+ "version" : "2.0",
+ "service" : "AWS Route53 Recovery Readiness",
+ "operations" : {
+ "CreateCell" : "Creates a new Cell.",
+ "CreateCrossAccountAuthorization" : "Create a new cross account readiness authorization.",
+ "CreateReadinessCheck" : "Creates a new Readiness Check.",
+ "CreateRecoveryGroup" : "Creates a new Recovery Group.",
+ "CreateResourceSet" : "Creates a new Resource Set.",
+ "DeleteCell" : "Deletes an existing Cell.",
+ "DeleteCrossAccountAuthorization" : "Delete cross account readiness authorization",
+ "DeleteReadinessCheck" : "Deletes an existing Readiness Check.",
+ "DeleteRecoveryGroup" : "Deletes an existing Recovery Group.",
+ "DeleteResourceSet" : "Deletes an existing Resource Set.",
+ "GetArchitectureRecommendations" : "Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.",
+ "GetCell" : "Returns information about a Cell.",
+ "GetCellReadinessSummary" : "Returns information about readiness of a Cell.",
+ "GetReadinessCheck" : "Returns information about a ReadinessCheck.",
+ "GetReadinessCheckResourceStatus" : "Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.",
+ "GetReadinessCheckStatus" : "Returns information about the status of a Readiness Check.",
+ "GetRecoveryGroup" : "Returns information about a Recovery Group.",
+ "GetRecoveryGroupReadinessSummary" : "Returns information about a Recovery Group.",
+ "GetResourceSet" : "Returns information about a Resource Set.",
+ "ListCells" : "Returns a collection of Cells.",
+ "ListCrossAccountAuthorizations" : "Returns a collection of cross account readiness authorizations.",
+ "ListReadinessChecks" : "Returns a collection of Readiness Checks.",
+ "ListRecoveryGroups" : "Returns a collection of Recovery Groups.",
+ "ListResourceSets" : "Returns a collection of Resource Sets.",
+ "ListRules" : "Returns a collection of rules that are applied as part of Readiness Checks.",
+ "ListTagsForResources" : "Returns a list of the tags assigned to the specified resource.",
+ "TagResource" : "Adds tags to the specified resource. You can specify one or more tags to add.",
+ "UntagResource" : "Removes tags from the specified resource. You can specify one or more tags to remove.",
+ "UpdateCell" : "Updates an existing Cell.",
+ "UpdateReadinessCheck" : "Updates an exisiting Readiness Check.",
+ "UpdateRecoveryGroup" : "Updates an existing Recovery Group.",
+ "UpdateResourceSet" : "Updates an existing Resource Set."
+ },
+ "shapes" : {
+ "CellCreateParameters" : {
+ "base" : "Parameters used to create a Cell",
+ "refs" : { }
+ },
+ "CellOutput" : {
+ "base" : "A Cell and its properties",
+ "refs" : {
+ "__listOfCellOutput$member" : null
+ }
+ },
+ "CellUpdateParameters" : {
+ "base" : "Parameters used to update a Cell",
+ "refs" : { }
+ },
+ "CreateCrossAccountAuthorizationParameters" : {
+ "base" : "Parameters used to create a cross account authorization",
+ "refs" : { }
+ },
+ "CreateCrossAccountAuthorizationResult" : {
+ "base" : "The response for a CreateCrossAccountAuthorization operation.",
+ "refs" : { }
+ },
+ "CrossAccountAuthorization" : {
+ "base" : "A cross-account authorization, e.g. arn:aws:iam::123456789012:root",
+ "refs" : {
+ "CreateCrossAccountAuthorizationParameters$CrossAccountAuthorization" : "The cross account authorization",
+ "CreateCrossAccountAuthorizationResult$CrossAccountAuthorization" : "The cross account authorization",
+ "__listOfCrossAccountAuthorization$member" : null
+ }
+ },
+ "DNSTargetResource" : {
+ "base" : "A component for DNS/Routing Control Readiness Checks",
+ "refs" : {
+ "Resource$DnsTargetResource" : null
+ }
+ },
+ "DeleteCrossAccountAuthorizationResult" : {
+ "base" : "The response for a DeleteCrossAccountAuthorization operation.",
+ "refs" : { }
+ },
+ "GetArchitectureRecommendationsOutput" : {
+ "base" : "Result from GetArchitectureRecommendations",
+ "refs" : { }
+ },
+ "GetCellReadinessSummaryOutput" : {
+ "base" : "Result of a GetReadinessCellSummary operation",
+ "refs" : { }
+ },
+ "GetReadinessCheckResourceStatusOutput" : {
+ "base" : "Result of a GetReadinessCheckResourceStatus operation",
+ "refs" : { }
+ },
+ "GetReadinessCheckStatusOutput" : {
+ "base" : "Result of a GetReadinessCheckStatus operation",
+ "refs" : { }
+ },
+ "GetRecoveryGroupReadinessSummaryOutput" : {
+ "base" : "Result of a GetReadinessRecoveryGroupSummary operation",
+ "refs" : { }
+ },
+ "LastAuditTimestamp" : {
+ "base" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format",
+ "refs" : {
+ "GetArchitectureRecommendationsOutput$LastAuditTimestamp" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format."
+ }
+ },
+ "ListCellsResult" : {
+ "base" : "Response object for listCells",
+ "refs" : { }
+ },
+ "ListCrossAccountAuthorizationsResult" : {
+ "base" : "The response for a ListCrossAccountAuthorizations operation.",
+ "refs" : { }
+ },
+ "ListReadinessChecksResult" : {
+ "base" : "Response object for ListReadinessChecks",
+ "refs" : { }
+ },
+ "ListRecoveryGroupsResult" : {
+ "base" : "Response object for listRecoveryGroups",
+ "refs" : { }
+ },
+ "ListResourceSetsResult" : {
+ "base" : "Response object for listResourceSets",
+ "refs" : { }
+ },
+ "ListRulesOutput" : {
+ "base" : "A collection of rules used in a readiness check",
+ "refs" : {
+ "__listOfListRulesOutput$member" : null
+ }
+ },
+ "ListRulesResult" : {
+ "base" : "Response object for List RulePacks",
+ "refs" : { }
+ },
+ "Message" : {
+ "base" : "Information relating to readiness check status",
+ "refs" : {
+ "__listOfMessage$member" : null
+ }
+ },
+ "NLBResource" : {
+ "base" : "The NLB resource a DNS Target Resource points to",
+ "refs" : {
+ "TargetResource$NLBResource" : null
+ }
+ },
+ "R53ResourceRecord" : {
+ "base" : "The Route 53 resource a DNS Target Resource record points to",
+ "refs" : {
+ "TargetResource$R53Resource" : null
+ }
+ },
+ "Readiness" : {
+ "base" : "The readiness of an entire ReadinessCheck or an individual resource ARN.",
+ "refs" : {
+ "GetCellReadinessSummaryOutput$Readiness" : "The readiness at Cell level.",
+ "GetReadinessCheckResourceStatusOutput$Readiness" : "The readiness at rule level.",
+ "GetReadinessCheckStatusOutput$Readiness" : "The readiness at rule level.",
+ "GetRecoveryGroupReadinessSummaryOutput$Readiness" : "The readiness at RecoveryGroup level.",
+ "ReadinessCheckSummary$Readiness" : "The readiness of this ReadinessCheck",
+ "ResourceResult$Readiness" : "The readiness of the resource.",
+ "RuleResult$Readiness" : "The readiness at rule level."
+ }
+ },
+ "ReadinessCheckCreateParameters" : {
+ "base" : "Parameters used to create or update a ReadinessCheck",
+ "refs" : { }
+ },
+ "ReadinessCheckOutput" : {
+ "base" : "A resource used for checking the readiness of a Resource Set",
+ "refs" : {
+ "__listOfReadinessCheckOutput$member" : null
+ }
+ },
+ "ReadinessCheckSummary" : {
+ "base" : "Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary",
+ "refs" : {
+ "__listOfReadinessCheckSummary$member" : null
+ }
+ },
+ "ReadinessCheckTimestamp" : {
+ "base" : "The time the Cell was last checked for readiness, in ISO-8601 format, UTC.",
+ "refs" : {
+ "ResourceResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC.",
+ "RuleResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC."
+ }
+ },
+ "ReadinessCheckUpdateParameters" : {
+ "base" : "Parameters used to create or update a ReadinessCheck",
+ "refs" : { }
+ },
+ "Recommendation" : {
+ "base" : "Guidance for improving Recovery Group resilliancy",
+ "refs" : {
+ "__listOfRecommendation$member" : null
+ }
+ },
+ "RecoveryGroupCreateParameters" : {
+ "base" : "Parameters used to create an RecoveryGroup",
+ "refs" : { }
+ },
+ "RecoveryGroupOutput" : {
+ "base" : "A Recovery Group generally containing multiple Cells",
+ "refs" : {
+ "__listOfRecoveryGroupOutput$member" : null
+ }
+ },
+ "RecoveryGroupUpdateParameters" : {
+ "base" : "Parameters used to update an RecoveryGroup",
+ "refs" : { }
+ },
+ "Resource" : {
+ "base" : "The resource element of a ResourceSet",
+ "refs" : {
+ "__listOfResource$member" : null
+ }
+ },
+ "ResourceResult" : {
+ "base" : "Result with status for an individual resource.",
+ "refs" : {
+ "__listOfResourceResult$member" : null
+ }
+ },
+ "ResourceSetCreateParameters" : {
+ "base" : "Parameters used to create a ResourceSet",
+ "refs" : { }
+ },
+ "ResourceSetOutput" : {
+ "base" : "A collection of resources of the same type",
+ "refs" : {
+ "__listOfResourceSetOutput$member" : null
+ }
+ },
+ "ResourceSetUpdateParameters" : {
+ "base" : "Parameters used to create a ResourceSet",
+ "refs" : { }
+ },
+ "RuleResult" : {
+ "base" : "Result with status for an individual rule..",
+ "refs" : {
+ "__listOfRuleResult$member" : null
+ }
+ },
+ "Tags" : {
+ "base" : "A collection of tags associated with a resource",
+ "refs" : {
+ "CellCreateParameters$Tags" : null,
+ "CellOutput$Tags" : null,
+ "ReadinessCheckCreateParameters$Tags" : null,
+ "ReadinessCheckOutput$Tags" : null,
+ "RecoveryGroupCreateParameters$Tags" : null,
+ "RecoveryGroupOutput$Tags" : null,
+ "ResourceSetCreateParameters$Tags" : null,
+ "ResourceSetOutput$Tags" : null,
+ "TagsModel$Tags" : null
+ }
+ },
+ "TagsModel" : {
+ "base" : null,
+ "refs" : { }
+ },
+ "TargetResource" : {
+ "base" : "The target resource the R53 record points to",
+ "refs" : {
+ "DNSTargetResource$TargetResource" : null
+ }
+ },
+ "__listOfCellOutput" : {
+ "base" : null,
+ "refs" : {
+ "ListCellsResult$Cells" : "A list of Cells"
+ }
+ },
+ "__listOfCrossAccountAuthorization" : {
+ "base" : null,
+ "refs" : {
+ "ListCrossAccountAuthorizationsResult$CrossAccountAuthorizations" : "A list of CrossAccountAuthorizations"
+ }
+ },
+ "__listOfListRulesOutput" : {
+ "base" : null,
+ "refs" : {
+ "ListRulesResult$Rules" : "A list of rules"
+ }
+ },
+ "__listOfMessage" : {
+ "base" : null,
+ "refs" : {
+ "GetReadinessCheckStatusOutput$Messages" : "Top level messages for readiness check status",
+ "RuleResult$Messages" : "Details about the resource's readiness"
+ }
+ },
+ "__listOfReadinessCheckOutput" : {
+ "base" : null,
+ "refs" : {
+ "ListReadinessChecksResult$ReadinessChecks" : "A list of ReadinessCheck associated with the account"
+ }
+ },
+ "__listOfReadinessCheckSummary" : {
+ "base" : null,
+ "refs" : {
+ "GetCellReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the Cell",
+ "GetRecoveryGroupReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the RecoveryGroup"
+ }
+ },
+ "__listOfRecommendation" : {
+ "base" : null,
+ "refs" : {
+ "GetArchitectureRecommendationsOutput$Recommendations" : "A list of recommendations for the customer's application"
+ }
+ },
+ "__listOfRecoveryGroupOutput" : {
+ "base" : null,
+ "refs" : {
+ "ListRecoveryGroupsResult$RecoveryGroups" : "A list of RecoveryGroups"
+ }
+ },
+ "__listOfResource" : {
+ "base" : null,
+ "refs" : {
+ "ResourceSetCreateParameters$Resources" : "A list of Resource objects",
+ "ResourceSetOutput$Resources" : "A list of Resource objects",
+ "ResourceSetUpdateParameters$Resources" : "A list of Resource objects"
+ }
+ },
+ "__listOfResourceResult" : {
+ "base" : null,
+ "refs" : {
+ "GetReadinessCheckStatusOutput$Resources" : "Summary of resources's readiness"
+ }
+ },
+ "__listOfResourceSetOutput" : {
+ "base" : null,
+ "refs" : {
+ "ListResourceSetsResult$ResourceSets" : "A list of ResourceSets associated with the account"
+ }
+ },
+ "__listOfRuleResult" : {
+ "base" : null,
+ "refs" : {
+ "GetReadinessCheckResourceStatusOutput$Rules" : "Details of the rules's results"
+ }
+ },
+ "__listOf__string" : {
+ "base" : null,
+ "refs" : {
+ "CellCreateParameters$Cells" : "A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)",
+ "CellOutput$Cells" : "A list of Cell arns",
+ "CellOutput$ParentReadinessScopes" : "A list of Cell ARNs and/or RecoveryGroup ARNs",
+ "CellUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list",
+ "RecoveryGroupCreateParameters$Cells" : "A list of Cell arns",
+ "RecoveryGroupOutput$Cells" : "A list of Cell arns",
+ "RecoveryGroupUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list",
+ "Resource$ReadinessScopes" : "A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within."
+ }
+ },
+ "__string" : {
+ "base" : null,
+ "refs" : {
+ "CellCreateParameters$CellName" : "The name of the Cell to create",
+ "DNSTargetResource$DomainName" : "The DNS Name that acts as ingress point to a portion of application",
+ "DNSTargetResource$HostedZoneArn" : "The Hosted Zone ARN that contains the DNS record with the provided name of target resource.",
+ "DNSTargetResource$RecordSetId" : "The R53 Set Id to uniquely identify a record given a Name and a Type",
+ "DNSTargetResource$RecordType" : "The Type of DNS Record of target resource",
+ "GetArchitectureRecommendationsOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection",
+ "GetCellReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "GetReadinessCheckResourceStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "GetReadinessCheckStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "GetRecoveryGroupReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListCellsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListCrossAccountAuthorizationsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListReadinessChecksResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListRecoveryGroupsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListResourceSetsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "ListRulesResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
+ "Message$MessageText" : "The text of a readiness check message",
+ "NLBResource$Arn" : "An NLB resource arn",
+ "R53ResourceRecord$DomainName" : "The DNS target name",
+ "R53ResourceRecord$RecordSetId" : "The Resource Record set id",
+ "ReadinessCheckCreateParameters$ReadinessCheckName" : "The name of the ReadinessCheck to create",
+ "ReadinessCheckCreateParameters$ResourceSetName" : "The name of the ResourceSet to check",
+ "ReadinessCheckSummary$ReadinessCheckName" : "The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell",
+ "ReadinessCheckUpdateParameters$ResourceSetName" : "The name of the ResourceSet to check",
+ "Recommendation$RecommendationText" : "Guidance text for recommendation",
+ "RecoveryGroupCreateParameters$RecoveryGroupName" : "The name of the RecoveryGroup to create",
+ "Resource$ComponentId" : "The component id of the resource, generated by the service when dnsTargetResource is used",
+ "Resource$ResourceArn" : "The ARN of the AWS resource, can be skipped if dnsTargetResource is used",
+ "ResourceResult$ComponentId" : "The component id of the resource",
+ "ResourceResult$ResourceArn" : "The ARN of the resource",
+ "ResourceSetCreateParameters$ResourceSetName" : "The name of the ResourceSet to create",
+ "RuleResult$RuleId" : "The identifier of the rule.",
+ "Tags$member" : null,
+ "__listOf__string$member" : null
+ }
+ },
+ "__stringMax256" : {
+ "base" : null,
+ "refs" : {
+ "CellOutput$CellArn" : "The arn for the Cell",
+ "ListRulesOutput$RuleDescription" : "A description of the rule",
+ "ReadinessCheckOutput$ReadinessCheckArn" : "Arn associated with ReadinessCheck",
+ "RecoveryGroupOutput$RecoveryGroupArn" : "The arn for the RecoveryGroup",
+ "ResourceSetOutput$ResourceSetArn" : "The arn for the ResourceSet"
+ }
+ },
+ "__stringMax64" : {
+ "base" : null,
+ "refs" : {
+ "ListRulesOutput$ResourceType" : "The resource type the rule applies to.",
+ "ListRulesOutput$RuleId" : "The Rule's ID."
+ }
+ },
+ "__stringMax64PatternAAZAZ09Z" : {
+ "base" : null,
+ "refs" : {
+ "CellOutput$CellName" : "The name of the Cell",
+ "ReadinessCheckOutput$ReadinessCheckName" : "Name for a ReadinessCheck",
+ "ReadinessCheckOutput$ResourceSet" : "Name of the ResourceSet to be checked",
+ "RecoveryGroupOutput$RecoveryGroupName" : "The name of the RecoveryGroup",
+ "ResourceSetOutput$ResourceSetName" : "The name of the ResourceSet"
+ }
+ },
+ "__stringPatternAWSAZaZ09AZaZ09" : {
+ "base" : null,
+ "refs" : {
+ "ResourceSetCreateParameters$ResourceSetType" : "AWS Resource type of the resources in the ResourceSet",
+ "ResourceSetOutput$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet",
+ "ResourceSetUpdateParameters$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet"
+ }
+ }
+ }
+}
diff --git a/models/apis/route53-recovery-readiness/2019-12-02/paginators-1.json b/models/apis/route53-recovery-readiness/2019-12-02/paginators-1.json
new file mode 100644
index 0000000000..4bcdba2fe9
--- /dev/null
+++ b/models/apis/route53-recovery-readiness/2019-12-02/paginators-1.json
@@ -0,0 +1,76 @@
+{
+ "pagination" : {
+ "ListReadinessChecks" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults",
+ "result_key" : "ReadinessChecks"
+ },
+ "ListResourceSets" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults",
+ "result_key" : "ResourceSets"
+ },
+ "ListCells" : {
+ "input_token" : "NextToken",
+ "output_token" : "NextToken",
+ "limit_key" : "MaxResults",
+ "result_key" : "Cells"
+ },
+ "ListRecoveryGroups": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "RecoveryGroups"
+ },
+ "ListRules": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Rules"
+ },
+ "ListCrossAccountAuthorizations": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "CrossAccountAuthorizations"
+ },
+ "GetCellReadinessSummary": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "ReadinessChecks",
+ "non_aggregate_keys": [
+ "Readiness"
+ ]
+ },
+ "GetRecoveryGroupReadinessSummary": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "ReadinessChecks",
+ "non_aggregate_keys": [
+ "Readiness"
+ ]
+ },
+ "GetReadinessCheckStatus": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Resources",
+ "non_aggregate_keys": [
+ "Readiness", "Messages"
+ ]
+ },
+ "GetReadinessCheckResourceStatus": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Rules",
+ "non_aggregate_keys": [
+ "Readiness"
+ ]
+ }
+ }
+}
diff --git a/models/apis/route53/2013-04-01/api-2.json b/models/apis/route53/2013-04-01/api-2.json
index 7dfc5bb2c4..2abfc874f5 100644
--- a/models/apis/route53/2013-04-01/api-2.json
+++ b/models/apis/route53/2013-04-01/api-2.json
@@ -25,7 +25,8 @@
{"shape":"NoSuchKeySigningKey"},
{"shape":"InvalidKeySigningKeyStatus"},
{"shape":"InvalidSigningStatus"},
- {"shape":"InvalidKMSArn"}
+ {"shape":"InvalidKMSArn"},
+ {"shape":"InvalidInput"}
]
},
"AssociateVPCWithHostedZone":{
@@ -302,7 +303,8 @@
{"shape":"InvalidKeySigningKeyStatus"},
{"shape":"InvalidSigningStatus"},
{"shape":"KeySigningKeyInUse"},
- {"shape":"KeySigningKeyInParentDSRecord"}
+ {"shape":"KeySigningKeyInParentDSRecord"},
+ {"shape":"InvalidInput"}
]
},
"DeleteHealthCheck":{
@@ -348,7 +350,8 @@
{"shape":"NoSuchKeySigningKey"},
{"shape":"InvalidKeySigningKeyStatus"},
{"shape":"InvalidSigningStatus"},
- {"shape":"InvalidKMSArn"}
+ {"shape":"InvalidKMSArn"},
+ {"shape":"InvalidInput"}
]
},
"DeleteQueryLoggingConfig":{
@@ -444,7 +447,8 @@
{"shape":"KeySigningKeyInParentDSRecord"},
{"shape":"DNSSECNotFound"},
{"shape":"InvalidKeySigningKeyStatus"},
- {"shape":"InvalidKMSArn"}
+ {"shape":"InvalidKMSArn"},
+ {"shape":"InvalidInput"}
]
},
"DisassociateVPCFromHostedZone":{
@@ -483,7 +487,8 @@
{"shape":"InvalidKMSArn"},
{"shape":"HostedZonePartiallyDelegated"},
{"shape":"DNSSECNotFound"},
- {"shape":"InvalidKeySigningKeyStatus"}
+ {"shape":"InvalidKeySigningKeyStatus"},
+ {"shape":"InvalidInput"}
]
},
"GetAccountLimit":{
@@ -530,7 +535,8 @@
"output":{"shape":"GetDNSSECResponse"},
"errors":[
{"shape":"NoSuchHostedZone"},
- {"shape":"InvalidArgument"}
+ {"shape":"InvalidArgument"},
+ {"shape":"InvalidInput"}
]
},
"GetGeoLocation":{
@@ -2399,7 +2405,8 @@
"EnableSNI":{"shape":"EnableSNI"},
"Regions":{"shape":"HealthCheckRegionList"},
"AlarmIdentifier":{"shape":"AlarmIdentifier"},
- "InsufficientDataHealthStatus":{"shape":"InsufficientDataHealthStatus"}
+ "InsufficientDataHealthStatus":{"shape":"InsufficientDataHealthStatus"},
+ "RoutingControlArn":{"shape":"RoutingControlArn"}
}
},
"HealthCheckCount":{"type":"long"},
@@ -2469,7 +2476,8 @@
"HTTPS_STR_MATCH",
"TCP",
"CALCULATED",
- "CLOUDWATCH_METRIC"
+ "CLOUDWATCH_METRIC",
+ "RECOVERY_CONTROL"
]
},
"HealthCheckVersion":{
@@ -3765,6 +3773,11 @@
"type":"string",
"enum":["MAX_ZONES_BY_REUSABLE_DELEGATION_SET"]
},
+ "RoutingControlArn":{
+ "type":"string",
+ "max":255,
+ "min":1
+ },
"SearchString":{
"type":"string",
"max":255
diff --git a/models/apis/route53/2013-04-01/docs-2.json b/models/apis/route53/2013-04-01/docs-2.json
index 9df047a614..e580cecb43 100644
--- a/models/apis/route53/2013-04-01/docs-2.json
+++ b/models/apis/route53/2013-04-01/docs-2.json
@@ -3,60 +3,60 @@
"service": "Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
",
"operations": {
"ActivateKeySigningKey": "Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.
",
- "AssociateVPCWithHostedZone": "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.
",
- "ChangeResourceRecordSets": "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.
",
- "ChangeTagsForResource": "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.
",
+ "AssociateVPCWithHostedZone": "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.
",
+ "ChangeResourceRecordSets": "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.
",
+ "ChangeTagsForResource": "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": "Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
ELB Load Balancers
If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.
Private Hosted Zones
You can associate health checks with failover resource record sets in a private hosted zone. Note the following:
-
Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.
-
You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.
-
You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
",
"CreateHostedZone": "Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
For more information about charges for hosted zones, see Amazon Route 53 Pricing.
Note the following:
-
You can't create a hosted zone for a top-level domain (TLD) such as .com.
-
For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.
-
If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.
The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.
",
"CreateKeySigningKey": "Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
",
- "CreateQueryLoggingConfig": "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
- Log Group and Resource Policy
-
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.
- Log Streams and Edge Locations
-
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.
- Queries That Are Logged
-
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.
- Log File Format
-
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.
- Pricing
-
For information about charges for query logs, see Amazon CloudWatch Pricing.
- How to Stop Logging
-
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
",
- "CreateReusableDelegationSet": "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.
",
+ "CreateQueryLoggingConfig": "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
- Log Group and Resource Policy
-
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.
- Log Streams and Edge Locations
-
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.
- Queries That Are Logged
-
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.
- Log File Format
-
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.
- Pricing
-
For information about charges for query logs, see Amazon CloudWatch Pricing.
- How to Stop Logging
-
If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
",
+ "CreateReusableDelegationSet": "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.
",
"CreateTrafficPolicy": "Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
",
"CreateTrafficPolicyInstance": "Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
",
"CreateTrafficPolicyVersion": "Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.
",
- "CreateVPCAssociationAuthorization": "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.
",
+ "CreateVPCAssociationAuthorization": "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.
",
"DeactivateKeySigningKey": "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.
",
- "DeleteHealthCheck": "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.
",
- "DeleteHostedZone": "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:
",
+ "DeleteHealthCheck": "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.
",
+ "DeleteHostedZone": "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:
",
"DeleteKeySigningKey": "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.
",
"DeleteQueryLoggingConfig": "Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.
For more information about DNS query logs, see CreateQueryLoggingConfig.
",
"DeleteReusableDelegationSet": "Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
",
"DeleteTrafficPolicy": "Deletes a traffic policy.
When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following:
-
Deleted traffic policies aren't listed if you run ListTrafficPolicies.
-
There's no way to get a list of deleted policies.
-
If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy.
",
"DeleteTrafficPolicyInstance": "Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
In the Route 53 console, traffic policy instances are known as policy records.
",
- "DeleteVPCAssociationAuthorization": "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.
",
+ "DeleteVPCAssociationAuthorization": "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.
",
"DisableHostedZoneDNSSEC": "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.
",
- "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 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.
",
+ "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.
",
"EnableHostedZoneDNSSEC": "Enables DNSSEC signing in a specific hosted zone.
",
- "GetAccountLimit": "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.
",
+ "GetAccountLimit": "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.
",
"GetChange": "Returns the current status of a change batch request. The status is one of the following values:
-
PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.
-
INSYNC indicates that the changes have propagated to all Route 53 DNS servers.
",
- "GetCheckerIpRanges": "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.
",
+ "GetCheckerIpRanges": "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.
",
"GetDNSSEC": "Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
",
"GetGeoLocation": "Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
Use the following syntax to determine whether a continent is supported for geolocation:
GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent
Use the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country code
Use the following syntax to determine whether a subdivision of a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code
",
"GetHealthCheck": "Gets information about a specified health check.
",
- "GetHealthCheckCount": "Retrieves the number of health checks that are associated with the current AWS account.
",
+ "GetHealthCheckCount": "Retrieves the number of health checks that are associated with the current account.
",
"GetHealthCheckLastFailureReason": "Gets the reason that a specified health check failed most recently.
",
- "GetHealthCheckStatus": "Gets status of a specified health check.
",
+ "GetHealthCheckStatus": "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.
",
"GetHostedZone": "Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
",
- "GetHostedZoneCount": "Retrieves the number of hosted zones that are associated with the current AWS account.
",
+ "GetHostedZoneCount": "Retrieves the number of hosted zones that are associated with the current account.
",
"GetHostedZoneLimit": "Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
",
"GetQueryLoggingConfig": "Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
",
"GetReusableDelegationSet": "Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
",
"GetReusableDelegationSetLimit": "Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
",
"GetTrafficPolicy": "Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.
",
"GetTrafficPolicyInstance": "Gets information about a specified traffic policy instance.
After you submit a CreateTrafficPolicyInstance or 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.
In the Route 53 console, traffic policy instances are known as policy records.
",
- "GetTrafficPolicyInstanceCount": "Gets the number of traffic policy instances that are associated with the current AWS account.
",
+ "GetTrafficPolicyInstanceCount": "Gets the number of traffic policy instances that are associated with the current account.
",
"ListGeoLocations": "Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
",
- "ListHealthChecks": "Retrieve a list of the health checks that are associated with the current AWS account.
",
- "ListHostedZones": "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.
",
- "ListHostedZonesByName": "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.
",
- "ListHostedZonesByVPC": "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.
",
- "ListQueryLoggingConfigs": "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.
",
+ "ListHealthChecks": "Retrieve a list of the health checks that are associated with the current account.
",
+ "ListHostedZones": "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.
",
+ "ListHostedZonesByName": "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.
",
+ "ListHostedZonesByVPC": "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.
",
+ "ListQueryLoggingConfigs": "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": "Lists the resource record sets in a specified hosted zone.
ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.
Sort order
ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! \" # $ % & ' ( ) * + , -
When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.
Specifying where to start listing records
You can use the name and type elements to specify the resource record set that the list begins with:
- If you do not specify Name or Type
-
The results begin with the first resource record set that the hosted zone contains.
- If you specify Name but not Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to Name.
- If you specify Type but not Name
-
Amazon Route 53 returns the InvalidInput error.
- If you specify both Name and Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.
Resource record sets that are PENDING
This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.
Changing resource record sets
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
Displaying the next page of results
If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.
",
- "ListReusableDelegationSets": "Retrieves a list of the reusable delegation sets that are associated with the current AWS account.
",
- "ListTagsForResource": "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.
",
- "ListTagsForResources": "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.
",
- "ListTrafficPolicies": "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.
",
- "ListTrafficPolicyInstances": "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.
",
+ "ListReusableDelegationSets": "Retrieves a list of the reusable delegation sets that are associated with the current account.
",
+ "ListTagsForResource": "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": "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": "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.
",
+ "ListTrafficPolicyInstances": "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.
",
"ListTrafficPolicyInstancesByHostedZone": "Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit a CreateTrafficPolicyInstance or 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.
",
"ListTrafficPolicyInstancesByPolicy": "Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a CreateTrafficPolicyInstance or 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.
",
"ListTrafficPolicyVersions": "Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by VersionNumber.
",
@@ -71,7 +71,7 @@
"AWSAccountID": {
"base": null,
"refs": {
- "HostedZoneOwner$OwningAccount": "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.
"
+ "HostedZoneOwner$OwningAccount": "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.
"
}
},
"AccountLimit": {
@@ -113,13 +113,13 @@
"AliasHealthEnabled": {
"base": null,
"refs": {
- "AliasTarget$EvaluateTargetHealth": " 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:
- CloudFront distributions
-
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
- Elastic Beanstalk environments that have regionalized subdomains
-
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.
- ELB load balancers
-
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.
- S3 buckets
-
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
- Other records in the same hosted zone
-
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.
"
+ "AliasTarget$EvaluateTargetHealth": " 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:
- CloudFront distributions
-
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
- Elastic Beanstalk environments that have regionalized subdomains
-
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.
- ELB load balancers
-
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.
- S3 buckets
-
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
- Other records in the same hosted zone
-
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.
"
}
},
"AliasTarget": {
- "base": " 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.
",
+ "base": " 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.
",
"refs": {
- "ResourceRecordSet$AliasTarget": " 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.
"
+ "ResourceRecordSet$AliasTarget": " 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.
"
}
},
"AssociateVPCComment": {
@@ -227,7 +227,7 @@
"CloudWatchLogsLogGroupArn": {
"base": null,
"refs": {
- "CreateQueryLoggingConfigRequest$CloudWatchLogsLogGroupArn": "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.
",
+ "CreateQueryLoggingConfigRequest$CloudWatchLogsLogGroupArn": "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.
",
"QueryLoggingConfig$CloudWatchLogsLogGroupArn": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
"
}
},
@@ -351,13 +351,13 @@
"DNSName": {
"base": null,
"refs": {
- "AliasTarget$DNSName": " Alias resource record sets only: The value that you specify depends on where you want to route queries:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
-
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.
- Amazon Virtual Private Cloud interface VPC endpoint
-
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.
- CloudFront distribution
-
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.
- Elastic Beanstalk environment
-
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.
- ELB load balancer
-
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:
-
AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
- AWS Global Accelerator accelerator
-
Specify the DNS name for your accelerator:
- Amazon S3 bucket that is configured as a static website
-
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.
- Another Route 53 resource record set
-
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.
",
+ "AliasTarget$DNSName": " Alias resource record sets only: The value that you specify depends on where you want to route queries:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
-
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.
- Amazon Virtual Private Cloud interface VPC endpoint
-
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.
- CloudFront distribution
-
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.
- Elastic Beanstalk environment
-
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.
- ELB load balancer
-
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:
-
CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:
- Global Accelerator accelerator
-
Specify the DNS name for your accelerator:
- Amazon S3 bucket that is configured as a static website
-
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.
- Another Route 53 resource record set
-
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.
",
"CreateHostedZoneRequest$Name": "The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.
",
"CreateTrafficPolicyInstanceRequest$Name": "The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance.
",
"DelegationSetNameServers$member": null,
"HostedZone$Name": "The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.
",
"HostedZoneSummary$Name": "The name of the private hosted zone, such as example.com.
",
- "ListHostedZonesByNameRequest$DNSName": "(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.
",
+ "ListHostedZonesByNameRequest$DNSName": "(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.
",
"ListHostedZonesByNameResponse$DNSName": "For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.
",
"ListHostedZonesByNameResponse$NextDNSName": "If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
",
"ListResourceRecordSetsRequest$StartRecordName": "The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.
",
@@ -445,7 +445,7 @@
"DelegationSets": {
"base": null,
"refs": {
- "ListReusableDelegationSetsResponse$DelegationSets": "A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account.
"
+ "ListReusableDelegationSetsResponse$DelegationSets": "A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current account.
"
}
},
"DeleteHealthCheckRequest": {
@@ -519,7 +519,7 @@
}
},
"DeleteVPCAssociationAuthorizationRequest": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -810,7 +810,7 @@
}
},
"GetHealthCheckCountRequest": {
- "base": "A request for the number of health checks that are associated with the current AWS account.
",
+ "base": "A request for the number of health checks that are associated with the current account.
",
"refs": {
}
},
@@ -850,7 +850,7 @@
}
},
"GetHostedZoneCountRequest": {
- "base": "A request to retrieve a count of all the hosted zones that are associated with the current AWS account.
",
+ "base": "A request to retrieve a count of all the hosted zones that are associated with the current account.
",
"refs": {
}
},
@@ -910,7 +910,7 @@
}
},
"GetTrafficPolicyInstanceCountRequest": {
- "base": "Request to get the number of traffic policy instances that are associated with the current AWS account.
",
+ "base": "Request to get the number of traffic policy instances that are associated with the current account.
",
"refs": {
}
},
@@ -940,10 +940,10 @@
}
},
"HealthCheck": {
- "base": "A complex type that contains information about one health check that is associated with the current AWS account.
",
+ "base": "A complex type that contains information about one health check that is associated with the current Amazon Web Services account.
",
"refs": {
"CreateHealthCheckResponse$HealthCheck": "A complex type that contains identifying information about the health check.
",
- "GetHealthCheckResponse$HealthCheck": "A complex type that contains information about one health check that is associated with the current AWS account.
",
+ "GetHealthCheckResponse$HealthCheck": "A complex type that contains information about one health check that is associated with the current account.
",
"HealthChecks$member": null,
"UpdateHealthCheckResponse$HealthCheck": "A complex type that contains the response to an UpdateHealthCheck request.
"
}
@@ -963,7 +963,7 @@
"HealthCheckCount": {
"base": null,
"refs": {
- "GetHealthCheckCountResponse$HealthCheckCount": "The number of health checks associated with the current AWS account.
"
+ "GetHealthCheckCountResponse$HealthCheckCount": "The number of health checks associated with the current account.
"
}
},
"HealthCheckId": {
@@ -1021,7 +1021,7 @@
"HealthCheckType": {
"base": null,
"refs": {
- "HealthCheckConfig$Type": "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.
"
+ "HealthCheckConfig$Type": "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.
"
}
},
"HealthCheckVersion": {
@@ -1039,7 +1039,7 @@
"HealthChecks": {
"base": null,
"refs": {
- "ListHealthChecksResponse$HealthChecks": "A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.
"
+ "ListHealthChecksResponse$HealthChecks": "A complex type that contains one HealthCheck element for each health check that is associated with the current account.
"
}
},
"HealthThreshold": {
@@ -1073,7 +1073,7 @@
"HostedZoneCount": {
"base": null,
"refs": {
- "GetHostedZoneCountResponse$HostedZoneCount": "The total number of public and private hosted zones that are associated with the current AWS account.
"
+ "GetHostedZoneCountResponse$HostedZoneCount": "The total number of public and private hosted zones that are associated with the current account.
"
}
},
"HostedZoneLimit": {
@@ -1107,13 +1107,13 @@
"HostedZoneOwner": {
"base": "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.
",
"refs": {
- "HostedZoneSummary$Owner": "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.
"
+ "HostedZoneSummary$Owner": "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.
"
}
},
"HostedZoneOwningService": {
"base": null,
"refs": {
- "HostedZoneOwner$OwningService": "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.
"
+ "HostedZoneOwner$OwningService": "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.
"
}
},
"HostedZonePartiallyDelegated": {
@@ -1151,7 +1151,7 @@
"refs": {
"HealthCheckConfig$IPAddress": "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
-
IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.
-
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.
",
"HealthCheckObservation$IPAddress": "The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.
",
- "TestDNSAnswerRequest$ResolverIP": "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).
",
+ "TestDNSAnswerRequest$ResolverIP": "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).
",
"TestDNSAnswerRequest$EDNS0ClientSubnetIP": "If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.
",
"UpdateHealthCheckRequest$IPAddress": "The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
-
IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.
-
IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:
If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
"
}
@@ -1168,7 +1168,7 @@
}
},
"InsufficientCloudWatchLogsResourcePolicy": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -1294,7 +1294,7 @@
}
},
"LimitsExceeded": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -1316,7 +1316,7 @@
}
},
"ListHealthChecksRequest": {
- "base": "A request to retrieve a list of the health checks that are associated with the current AWS account.
",
+ "base": "A request to retrieve a list of the health checks that are associated with the current account.
",
"refs": {
}
},
@@ -1326,7 +1326,7 @@
}
},
"ListHostedZonesByNameRequest": {
- "base": "Retrieves a list of the public and private hosted zones that are associated with the current AWS account in ASCII order by domain name.
",
+ "base": "Retrieves a list of the public and private hosted zones that are associated with the current account in ASCII order by domain name.
",
"refs": {
}
},
@@ -1336,7 +1336,7 @@
}
},
"ListHostedZonesByVPCRequest": {
- "base": "Lists all the private hosted zones that a specified VPC is associated with, regardless of which AWS account created the hosted zones.
",
+ "base": "Lists all the private hosted zones that a specified VPC is associated with, regardless of which account created the hosted zones.
",
"refs": {
}
},
@@ -1346,7 +1346,7 @@
}
},
"ListHostedZonesRequest": {
- "base": "A request to retrieve a list of the public and private hosted zones that are associated with the current AWS account.
",
+ "base": "A request to retrieve a list of the public and private hosted zones that are associated with the current account.
",
"refs": {
}
},
@@ -1376,12 +1376,12 @@
}
},
"ListReusableDelegationSetsRequest": {
- "base": "A request to get a list of the reusable delegation sets that are associated with the current AWS account.
",
+ "base": "A request to get a list of the reusable delegation sets that are associated with the current account.
",
"refs": {
}
},
"ListReusableDelegationSetsResponse": {
- "base": "A complex type that contains information about the reusable delegation sets that are associated with the current AWS account.
",
+ "base": "A complex type that contains information about the reusable delegation sets that are associated with the current account.
",
"refs": {
}
},
@@ -1406,7 +1406,7 @@
}
},
"ListTrafficPoliciesRequest": {
- "base": "A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
",
+ "base": "A complex type that contains the information about the request to list the traffic policies that are associated with the current account.
",
"refs": {
}
},
@@ -1436,7 +1436,7 @@
}
},
"ListTrafficPolicyInstancesRequest": {
- "base": "A request to get information about the traffic policy instances that you created by using the current AWS account.
",
+ "base": "A request to get information about the traffic policy instances that you created by using the current account.
",
"refs": {
}
},
@@ -1468,14 +1468,14 @@
"MaxResults": {
"base": null,
"refs": {
- "ListQueryLoggingConfigsRequest$MaxResults": "(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.
",
+ "ListQueryLoggingConfigsRequest$MaxResults": "(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.
",
"ListVPCAssociationAuthorizationsRequest$MaxResults": " Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.
"
}
},
"MeasureLatency": {
"base": null,
"refs": {
- "HealthCheckConfig$MeasureLatency": "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.
"
+ "HealthCheckConfig$MeasureLatency": "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.
"
}
},
"Message": {
@@ -1630,9 +1630,9 @@
"base": null,
"refs": {
"ListHostedZonesByVPCRequest$NextToken": "If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.
For the value of NextToken, specify the value of NextToken from the previous response.
If the previous response didn't include a NextToken element, there are no more hosted zones to get.
",
- "ListHostedZonesByVPCResponse$NextToken": "The value that you specified for NextToken in the most recent ListHostedZonesByVPC request.
",
- "ListQueryLoggingConfigsRequest$NextToken": "(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.
",
- "ListQueryLoggingConfigsResponse$NextToken": "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.
",
+ "ListHostedZonesByVPCResponse$NextToken": "The value that you will use for NextToken in the next ListHostedZonesByVPC request.
",
+ "ListQueryLoggingConfigsRequest$NextToken": "(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.
",
+ "ListQueryLoggingConfigsResponse$NextToken": "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.
",
"ListVPCAssociationAuthorizationsRequest$NextToken": " Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request.
",
"ListVPCAssociationAuthorizationsResponse$NextToken": "When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter.
"
}
@@ -1684,7 +1684,7 @@
"QueryLoggingConfigs": {
"base": null,
"refs": {
- "ListQueryLoggingConfigsResponse$QueryLoggingConfigs": "An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account.
"
+ "ListQueryLoggingConfigsResponse$QueryLoggingConfigs": "An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current account.
"
}
},
"RData": {
@@ -1719,7 +1719,7 @@
}
},
"RecordDataEntry": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"RecordData$member": null
}
@@ -1746,7 +1746,7 @@
"base": null,
"refs": {
"ChangeBatch$Comment": " Optional: Any comments you want to include about a change batch request.
",
- "ChangeInfo$Comment": "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.
",
+ "ChangeInfo$Comment": "A comment you can provide.
",
"HostedZoneConfig$Comment": "Any comments that you want to include about the hosted zone.
",
"LinkedService$Description": "If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
",
"UpdateHostedZoneCommentRequest$Comment": "The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.
"
@@ -1756,9 +1756,9 @@
"base": null,
"refs": {
"ActivateKeySigningKeyRequest$HostedZoneId": "A unique string used to identify a hosted zone.
",
- "AliasTarget$HostedZoneId": " Alias resource records sets only: The value used depends on where you want to route traffic:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
-
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.
- Amazon Virtual Private Cloud interface VPC endpoint
-
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.
- CloudFront distribution
-
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
- Elastic Beanstalk environment
-
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.
- ELB load balancer
-
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:
-
AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
- AWS Global Accelerator accelerator
-
Specify Z2BJ6XQ5FK7U4H.
- An Amazon S3 bucket configured as a static website
-
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.
- Another Route 53 resource record set in your hosted zone
-
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.)
",
+ "AliasTarget$HostedZoneId": " Alias resource records sets only: The value used depends on where you want to route traffic:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
-
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.
- Amazon Virtual Private Cloud interface VPC endpoint
-
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.
- CloudFront distribution
-
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a private zone.
- Elastic Beanstalk environment
-
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.
- ELB load balancer
-
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:
-
CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:
- Global Accelerator accelerator
-
Specify Z2BJ6XQ5FK7U4H.
- An Amazon S3 bucket configured as a static website
-
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.
- Another Route 53 resource record set in your hosted zone
-
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.)
",
"AssociateVPCWithHostedZoneRequest$HostedZoneId": "The ID of the private hosted zone that you want to associate an Amazon VPC with.
Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.
",
- "ChangeInfo$Id": "The ID of the request.
",
+ "ChangeInfo$Id": "This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
",
"ChangeResourceRecordSetsRequest$HostedZoneId": "The ID of the hosted zone that contains the resource record sets that you want to change.
",
"CreateHostedZoneRequest$DelegationSetId": "If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.
",
"CreateKeySigningKeyRequest$HostedZoneId": "The unique string (ID) used to identify a hosted zone.
",
@@ -1772,7 +1772,7 @@
"DeleteHostedZoneRequest$Id": "The ID of the hosted zone you want to delete.
",
"DeleteKeySigningKeyRequest$HostedZoneId": "A unique string used to identify a hosted zone.
",
"DeleteReusableDelegationSetRequest$Id": "The ID of the reusable delegation set that you want to delete.
",
- "DeleteVPCAssociationAuthorizationRequest$HostedZoneId": "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.
",
+ "DeleteVPCAssociationAuthorizationRequest$HostedZoneId": "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.
",
"DisableHostedZoneDNSSECRequest$HostedZoneId": "A unique string used to identify a hosted zone.
",
"DisassociateVPCFromHostedZoneRequest$HostedZoneId": "The ID of the private hosted zone that you want to disassociate a VPC from.
",
"EnableHostedZoneDNSSECRequest$HostedZoneId": "A unique string used to identify a hosted zone.
",
@@ -1788,7 +1788,7 @@
"ListHostedZonesByNameResponse$HostedZoneId": "The ID that Amazon Route 53 assigned to the hosted zone when you created it.
",
"ListHostedZonesByNameResponse$NextHostedZoneId": "If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
",
"ListHostedZonesRequest$DelegationSetId": "If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.
",
- "ListQueryLoggingConfigsRequest$HostedZoneId": "(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.
",
+ "ListQueryLoggingConfigsRequest$HostedZoneId": "(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.
",
"ListResourceRecordSetsRequest$HostedZoneId": "The ID of the hosted zone that contains the resource record sets that you want to list.
",
"ListTrafficPolicyInstancesByHostedZoneRequest$HostedZoneId": "The ID of the hosted zone that you want to list traffic policy instances for.
",
"ListTrafficPolicyInstancesByPolicyRequest$HostedZoneIdMarker": "If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.
For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
",
@@ -1846,7 +1846,7 @@
"ResourceRecordSetRegion": {
"base": null,
"refs": {
- "ResourceRecordSet$Region": " 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.
"
+ "ResourceRecordSet$Region": " 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.
"
}
},
"ResourceRecordSetWeight": {
@@ -1906,6 +1906,12 @@
"ReusableDelegationSetLimit$Type": "The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate with the specified reusable delegation set.
"
}
},
+ "RoutingControlArn": {
+ "base": null,
+ "refs": {
+ "HealthCheckConfig$RoutingControlArn": "The Amazon Resource Name (ARN) for Route53 Application Recovery Controller routing control.
"
+ }
+ },
"SearchString": {
"base": null,
"refs": {
@@ -1960,8 +1966,8 @@
"SigningKeyString": {
"base": null,
"refs": {
- "CreateKeySigningKeyRequest$KeyManagementServiceArn": "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:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
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:
For more information about working with a customer managed CMK in AWS KMS, see AWS Key Management Service concepts.
",
- "KeySigningKey$KmsArn": "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:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
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:
For more information about working with the customer managed CMK in AWS KMS, see AWS Key Management Service concepts.
",
+ "CreateKeySigningKeyRequest$KeyManagementServiceArn": "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:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
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:
For more information about working with a customer managed CMK in KMS, see Key Management Service concepts.
",
+ "KeySigningKey$KmsArn": "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:
- Status
-
Enabled
- Key spec
-
ECC_NIST_P256
- Key usage
-
Sign and verify
- Key policy
-
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:
For more information about working with the customer managed CMK in KMS, see Key Management Service concepts.
",
"KeySigningKey$SigningAlgorithmMnemonic": "A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
",
"KeySigningKey$DigestAlgorithmMnemonic": "A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
",
"KeySigningKey$DigestValue": "A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
",
@@ -2096,12 +2102,12 @@
}
},
"TooManyHealthChecks": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
"TooManyHostedZones": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -2111,12 +2117,12 @@
}
},
"TooManyTrafficPolicies": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
"TooManyTrafficPolicyInstances": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -2208,7 +2214,7 @@
"TrafficPolicyInstanceCount": {
"base": null,
"refs": {
- "GetTrafficPolicyInstanceCountResponse$TrafficPolicyInstanceCount": "The number of traffic policy instances that are associated with the current AWS account.
"
+ "GetTrafficPolicyInstanceCountResponse$TrafficPolicyInstanceCount": "The number of traffic policy instances that are associated with the current account.
"
}
},
"TrafficPolicyInstanceId": {
@@ -2246,11 +2252,11 @@
"TrafficPolicySummaries": {
"base": null,
"refs": {
- "ListTrafficPoliciesResponse$TrafficPolicySummaries": "A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
"
+ "ListTrafficPoliciesResponse$TrafficPolicySummaries": "A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current account.
"
}
},
"TrafficPolicySummary": {
- "base": "A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.
",
+ "base": "A complex type that contains information about the latest version of one traffic policy that is associated with the current account.
",
"refs": {
"TrafficPolicySummaries$member": null
}
@@ -2265,7 +2271,7 @@
"TrafficPolicy$Version": "The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.
",
"TrafficPolicyInstance$TrafficPolicyVersion": "The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.
",
"TrafficPolicySummary$LatestVersion": "The version number of the latest version of the traffic policy.
",
- "TrafficPolicySummary$TrafficPolicyCount": "The number of traffic policies that are associated with the current AWS account.
",
+ "TrafficPolicySummary$TrafficPolicyCount": "The number of traffic policies that are associated with the current account.
",
"UpdateTrafficPolicyCommentRequest$Version": "The value of Version for the traffic policy that you want to update the comment for.
",
"UpdateTrafficPolicyInstanceRequest$TrafficPolicyVersion": "The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
"
}
@@ -2339,7 +2345,7 @@
"CreateHostedZoneResponse$VPC": "A complex type that contains information about an Amazon VPC that you associated with this hosted zone.
",
"CreateVPCAssociationAuthorizationRequest$VPC": "A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.
",
"CreateVPCAssociationAuthorizationResponse$VPC": "The VPC that you authorized associating with a hosted zone.
",
- "DeleteVPCAssociationAuthorizationRequest$VPC": "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.
",
+ "DeleteVPCAssociationAuthorizationRequest$VPC": "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.
",
"DisassociateVPCFromHostedZoneRequest$VPC": "A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.
",
"VPCs$member": null
}
@@ -2364,7 +2370,7 @@
"VPCRegion": {
"base": null,
"refs": {
- "ListHostedZonesByVPCRequest$VPCRegion": "For the Amazon VPC that you specified for VPCId, the AWS Region that you created the VPC in.
",
+ "ListHostedZonesByVPCRequest$VPCRegion": "For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.
",
"VPC$VPCRegion": "(Private hosted zones only) The region that an Amazon VPC was created in.
"
}
},
diff --git a/models/apis/shield/2016-06-02/docs-2.json b/models/apis/shield/2016-06-02/docs-2.json
index 078be92e2e..242e65f8b4 100644
--- a/models/apis/shield/2016-06-02/docs-2.json
+++ b/models/apis/shield/2016-06-02/docs-2.json
@@ -1,38 +1,38 @@
{
"version": "2.0",
- "service": "AWS Shield Advanced 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.
",
+ "service": "Shield Advanced 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.
",
"operations": {
- "AssociateDRTLogBucket": "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.
",
- "AssociateDRTRole": "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.
",
- "AssociateHealthCheck": "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.
",
- "AssociateProactiveEngagementDetails": "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.
",
- "CreateProtection": "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.
",
+ "AssociateDRTLogBucket": "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.
",
+ "AssociateDRTRole": "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.
",
+ "AssociateHealthCheck": "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": "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.
",
+ "CreateProtection": "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": "Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
",
- "CreateSubscription": "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.
",
- "DeleteProtection": "Deletes an AWS Shield Advanced Protection.
",
+ "CreateSubscription": "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.
",
+ "DeleteProtection": "Deletes an Shield Advanced Protection.
",
"DeleteProtectionGroup": "Removes the specified protection group.
",
- "DeleteSubscription": "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.
",
+ "DeleteSubscription": "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.
",
"DescribeAttack": "Describes the details of a DDoS attack.
",
- "DescribeAttackStatistics": "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.
",
- "DescribeDRTAccess": "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.
",
- "DescribeEmergencyContactSettings": "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.
",
+ "DescribeAttackStatistics": "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": "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": "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": "Lists the details of a Protection object.
",
"DescribeProtectionGroup": "Returns the specification for the specified protection group.
",
- "DescribeSubscription": "Provides details about the AWS Shield Advanced subscription for an account.
",
- "DisableProactiveEngagement": "Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
",
- "DisassociateDRTLogBucket": "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.
",
- "DisassociateDRTRole": "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.
",
- "DisassociateHealthCheck": "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.
",
- "EnableProactiveEngagement": "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.
",
+ "DescribeSubscription": "Provides details about the Shield Advanced subscription for an account.
",
+ "DisableProactiveEngagement": "Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
",
+ "DisassociateDRTLogBucket": "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.
",
+ "DisassociateDRTRole": "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.
",
+ "DisassociateHealthCheck": "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": "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": "Returns the SubscriptionState, either Active or Inactive.
",
"ListAttacks": "Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
",
"ListProtectionGroups": "Retrieves the ProtectionGroup objects for the account.
",
"ListProtections": "Lists all Protection objects for the account.
",
"ListResourcesInProtectionGroup": "Retrieves the resources that are included in the protection group.
",
- "ListTagsForResource": "Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield.
",
- "TagResource": "Adds or updates tags for a resource in AWS Shield.
",
- "UntagResource": "Removes tags from a resource in AWS Shield.
",
- "UpdateEmergencyContactSettings": "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.
",
+ "ListTagsForResource": "Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
",
+ "TagResource": "Adds or updates tags for a resource in Shield.
",
+ "UntagResource": "Removes tags from a resource in Shield.
",
+ "UpdateEmergencyContactSettings": "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": "Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
",
"UpdateSubscription": "Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
"
},
@@ -43,7 +43,7 @@
}
},
"AccessDeniedForDependencyException": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
}
},
@@ -103,17 +103,17 @@
"AttackLayer": {
"base": null,
"refs": {
- "AttackProperty$AttackLayer": "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.
"
+ "AttackProperty$AttackLayer": "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.
"
}
},
"AttackProperties": {
"base": null,
"refs": {
- "AttackDetail$AttackProperties": "The array of AttackProperty objects.
"
+ "AttackDetail$AttackProperties": "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.
"
}
},
"AttackProperty": {
- "base": "Details of the described attack.
",
+ "base": "Details of a Shield event. This is provided as part of an AttackDetail.
",
"refs": {
"AttackProperties$member": null
}
@@ -121,7 +121,7 @@
"AttackPropertyIdentifier": {
"base": null,
"refs": {
- "AttackProperty$AttackPropertyIdentifier": "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.
"
+ "AttackProperty$AttackPropertyIdentifier": "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.
"
}
},
"AttackStatisticsDataItem": {
@@ -386,7 +386,7 @@
"DurationInSeconds": {
"base": null,
"refs": {
- "Subscription$TimeCommitmentInSeconds": "The length, in seconds, of the AWS Shield Advanced subscription for the account.
"
+ "Subscription$TimeCommitmentInSeconds": "The length, in seconds, of the Shield Advanced subscription for the account.
"
}
},
"EmailAddress": {
@@ -396,7 +396,7 @@
}
},
"EmergencyContact": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"EmergencyContactList$member": null
}
@@ -404,9 +404,9 @@
"EmergencyContactList": {
"base": null,
"refs": {
- "AssociateProactiveEngagementDetailsRequest$EmergencyContactList": "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.
",
- "DescribeEmergencyContactSettingsResponse$EmergencyContactList": "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.
",
- "UpdateEmergencyContactSettingsRequest$EmergencyContactList": "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.
"
+ "AssociateProactiveEngagementDetailsRequest$EmergencyContactList": "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.
",
+ "DescribeEmergencyContactSettingsResponse$EmergencyContactList": "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.
",
+ "UpdateEmergencyContactSettingsRequest$EmergencyContactList": "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.
"
}
},
"EnableProactiveEngagementRequest": {
@@ -567,21 +567,21 @@
"LogBucket": {
"base": null,
"refs": {
- "AssociateDRTLogBucketRequest$LogBucket": "The Amazon S3 bucket that contains your AWS WAF logs.
",
- "DisassociateDRTLogBucketRequest$LogBucket": "The Amazon S3 bucket that contains your AWS WAF logs.
",
+ "AssociateDRTLogBucketRequest$LogBucket": "The Amazon S3 bucket that contains the logs that you want to share.
",
+ "DisassociateDRTLogBucketRequest$LogBucket": "The Amazon S3 bucket that contains the logs that you want to share.
",
"LogBucketList$member": null
}
},
"LogBucketList": {
"base": null,
"refs": {
- "DescribeDRTAccessResponse$LogBucketList": "The list of Amazon S3 buckets accessed by the DRT.
"
+ "DescribeDRTAccessResponse$LogBucketList": "The list of Amazon S3 buckets accessed by the SRT.
"
}
},
"Long": {
"base": null,
"refs": {
- "AttackProperty$Total": "The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.
",
+ "AttackProperty$Total": "The total contributions made to this Shield event by all contributors.
",
"AttackStatisticsDataItem$AttackCount": "The number of attacks detected during the time period. This is always present, but might be zero.
",
"Contributor$Value": "The contribution of this contributor expressed in Protection units. For example 10,000.
",
"Limit$Max": "The maximum number of protections that can be created for the specified Type.
",
@@ -629,7 +629,7 @@
"ProactiveEngagementStatus": {
"base": null,
"refs": {
- "Subscription$ProactiveEngagementStatus": "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.
"
+ "Subscription$ProactiveEngagementStatus": "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.
"
}
},
"ProtectedResourceType": {
@@ -648,18 +648,18 @@
}
},
"ProtectionGroup": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
- "DescribeProtectionGroupResponse$ProtectionGroup": "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.
",
+ "DescribeProtectionGroupResponse$ProtectionGroup": "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.
",
"ProtectionGroups$member": null
}
},
"ProtectionGroupAggregation": {
"base": null,
"refs": {
- "CreateProtectionGroupRequest$Aggregation": "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.
",
- "ProtectionGroup$Aggregation": "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.
",
- "UpdateProtectionGroupRequest$Aggregation": "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.
"
+ "CreateProtectionGroupRequest$Aggregation": "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.
",
+ "ProtectionGroup$Aggregation": "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.
",
+ "UpdateProtectionGroupRequest$Aggregation": "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.
"
}
},
"ProtectionGroupArbitraryPatternLimits": {
@@ -752,10 +752,10 @@
"base": null,
"refs": {
"AttackDetail$ResourceArn": "The ARN (Amazon Resource Name) of the resource that was attacked.
",
- "CreateProtectionRequest$ResourceArn": "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
",
- "DescribeProtectionRequest$ResourceArn": "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.
",
+ "CreateProtectionRequest$ResourceArn": "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
",
+ "DescribeProtectionRequest$ResourceArn": "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.
",
"ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the resource to get tags for.
",
- "Protection$ResourceArn": "The ARN (Amazon Resource Name) of the AWS resource that is protected.
",
+ "Protection$ResourceArn": "The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
",
"Protection$ProtectionArn": "The ARN (Amazon Resource Name) of the protection.
",
"ProtectionGroup$ProtectionGroupArn": "The ARN (Amazon Resource Name) of the protection group.
",
"ProtectionGroupMembers$member": null,
@@ -786,8 +786,8 @@
"RoleArn": {
"base": null,
"refs": {
- "AssociateDRTRoleRequest$RoleArn": "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.
",
- "DescribeDRTAccessResponse$RoleArn": "The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.
"
+ "AssociateDRTRoleRequest$RoleArn": "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.
",
+ "DescribeDRTAccessResponse$RoleArn": "The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.
"
}
},
"String": {
@@ -828,9 +828,9 @@
}
},
"Subscription": {
- "base": "Information about the AWS Shield Advanced subscription for an account.
",
+ "base": "Information about the Shield Advanced subscription for an account.
",
"refs": {
- "DescribeSubscriptionResponse$Subscription": "The AWS Shield Advanced subscription details for an account.
"
+ "DescribeSubscriptionResponse$Subscription": "The Shield Advanced subscription details for an account.
"
}
},
"SubscriptionLimits": {
@@ -872,7 +872,7 @@
}
},
"Tag": {
- "base": "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.
",
+ "base": "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.
",
"refs": {
"TagList$member": null
}
@@ -936,23 +936,23 @@
"ListAttacksRequest$NextToken": "The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
",
"ListAttacksResponse$NextToken": "The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.
Shield Advanced might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more attack summary objects to return, Shield Advanced will always also return a NextToken.
",
"ListProtectionGroupsRequest$NextToken": "The next token value from a previous call to ListProtectionGroups. Pass null if this is the first call.
",
- "ListProtectionGroupsResponse$NextToken": "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.
",
+ "ListProtectionGroupsResponse$NextToken": "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.
",
"ListProtectionsRequest$NextToken": "The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
",
- "ListProtectionsResponse$NextToken": "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.
",
+ "ListProtectionsResponse$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.
",
"ListResourcesInProtectionGroupRequest$NextToken": "The next token value from a previous call to ListResourcesInProtectionGroup. Pass null if this is the first call.
",
- "ListResourcesInProtectionGroupResponse$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.
"
+ "ListResourcesInProtectionGroupResponse$NextToken": "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.
"
}
},
"TopContributors": {
"base": null,
"refs": {
- "AttackProperty$TopContributors": "The array of contributor objects that includes the top five contributors to an attack.
"
+ "AttackProperty$TopContributors": "Contributor objects for the top five contributors to a Shield event.
"
}
},
"Unit": {
"base": null,
"refs": {
- "AttackProperty$Unit": "The unit of the Value of the contributions.
"
+ "AttackProperty$Unit": "The unit used for the Contributor Value property.
"
}
},
"UntagResourceRequest": {
diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json
index 487da328ed..b04bea45ed 100644
--- a/models/endpoints/endpoints.json
+++ b/models/endpoints/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" ]
diff --git a/service/batch/api.go b/service/batch/api.go
index ec9685df06..a6f53f04f1 100644
--- a/service/batch/api.go
+++ b/service/batch/api.go
@@ -57,10 +57,10 @@ func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, o
// CancelJob API operation for AWS Batch.
//
-// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -144,11 +144,11 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI
// CreateComputeEnvironment API operation for AWS Batch.
//
-// Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED
+// Creates an 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.
+// Fargate resources. UNMANAGED compute environments can only use EC2 resources.
//
-// In a managed compute environment, AWS Batch manages the capacity and instance
+// 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html)
// that you specify when you create the compute environment. Either, you can
@@ -172,12 +172,12 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI
// see Launching an Amazon ECS container instance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html)
// in the Amazon Elastic Container Service Developer Guide.
//
-// AWS Batch doesn't upgrade the AMIs in a compute environment after the environment
+// 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
+// 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.
@@ -270,15 +270,15 @@ func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) (req *request.
// CreateJobQueue API operation for AWS Batch.
//
-// 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
+// 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
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -363,12 +363,12 @@ func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentI
// DeleteComputeEnvironment API operation for AWS Batch.
//
-// Deletes an AWS Batch compute environment.
+// 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 AWS Fargate resources must terminate all active jobs on that compute
+// 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.
//
@@ -546,8 +546,8 @@ func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInp
// DeregisterJobDefinition API operation for AWS Batch.
//
-// Deregisters an AWS Batch job definition. Job definitions are permanently
-// deleted after 180 days.
+// Deregisters an Batch job definition. Job definitions are permanently deleted
+// after 180 days.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1062,7 +1062,7 @@ func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) (req *request.Requ
// DescribeJobs API operation for AWS Batch.
//
-// Describes a list of AWS Batch jobs.
+// Describes a list of Batch jobs.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1152,7 +1152,7 @@ func (c *Batch) ListJobsRequest(input *ListJobsInput) (req *request.Request, out
// ListJobs API operation for AWS Batch.
//
-// Returns a list of AWS Batch jobs.
+// Returns a list of Batch jobs.
//
// You must specify only one of the following items:
//
@@ -1299,9 +1299,9 @@ func (c *Batch) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req
// ListTagsForResource API operation for AWS Batch.
//
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1385,7 +1385,7 @@ func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput)
// RegisterJobDefinition API operation for AWS Batch.
//
-// Registers an AWS Batch job definition.
+// Registers an Batch job definition.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1469,7 +1469,7 @@ func (c *Batch) SubmitJobRequest(input *SubmitJobInput) (req *request.Request, o
// SubmitJob API operation for AWS Batch.
//
-// Submits an AWS Batch job from a job definition. Parameters that are specified
+// 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
@@ -1566,8 +1566,8 @@ func (c *Batch) TagResourceRequest(input *TagResourceInput) (req *request.Reques
//
// 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
+// 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.
//
@@ -1741,7 +1741,7 @@ func (c *Batch) UntagResourceRequest(input *UntagResourceInput) (req *request.Re
// UntagResource API operation for AWS Batch.
//
-// Deletes specified tags from an AWS Batch resource.
+// Deletes specified tags from an Batch resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1825,7 +1825,7 @@ func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentI
// UpdateComputeEnvironment API operation for AWS Batch.
//
-// Updates an AWS Batch compute environment.
+// Updates an Batch compute environment.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1949,7 +1949,7 @@ func (c *Batch) UpdateJobQueueWithContext(ctx aws.Context, input *UpdateJobQueue
return out, req.Send()
}
-// An object representing an AWS Batch array job.
+// An object representing an Batch array job.
type ArrayProperties struct {
_ struct{} `type:"structure"`
@@ -2063,8 +2063,8 @@ type AttemptContainerDetail struct {
ExitCode *int64 `locationName:"exitCode" type:"integer"`
// 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 log group for Batch jobs is /aws/batch/job. Each container attempt receives
+ // a log stream name when they reach the RUNNING status.
LogStreamName *string `locationName:"logStreamName" type:"string"`
// The network interfaces associated with the job attempt.
@@ -2185,14 +2185,14 @@ func (s *AttemptDetail) SetStoppedAt(v int64) *AttemptDetail {
type CancelJobInput struct {
_ struct{} `type:"structure"`
- // The AWS Batch job ID of the job to cancel.
+ // The Batch job ID of the job to cancel.
//
// JobId is a required field
JobId *string `locationName:"jobId" type:"string" required:"true"`
// 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.
+ // message is also recorded in the Batch activity logs.
//
// Reason is a required field
Reason *string `locationName:"reason" type:"string" required:"true"`
@@ -2308,7 +2308,7 @@ func (s *ClientException) RequestID() string {
return s.RespMetadata.RequestID
}
-// An object representing an AWS Batch compute environment.
+// An object representing an Batch compute environment.
type ComputeEnvironmentDetail struct {
_ struct{} `type:"structure"`
@@ -2325,7 +2325,7 @@ type ComputeEnvironmentDetail struct {
// The compute resources defined for the compute environment. For more information,
// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"`
// The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used
@@ -2334,21 +2334,21 @@ type ComputeEnvironmentDetail struct {
// EcsClusterArn is a required field
EcsClusterArn *string `locationName:"ecsClusterArn" type:"string" required:"true"`
- // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
- // in the AWS Batch User Guide.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
+ // in the Batch User Guide.
ServiceRole *string `locationName:"serviceRole" type:"string"`
// 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 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 AWS Batch scheduler doesn't attempt to
- // place jobs within the environment. Jobs in a STARTING or RUNNING state continue
+ // 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.
@@ -2366,7 +2366,7 @@ type ComputeEnvironmentDetail struct {
// The type of the compute environment: MANAGED or UNMANAGED. For more information,
// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
Type *string `locationName:"type" type:"string" enum:"CEType"`
}
@@ -2450,8 +2450,8 @@ func (s *ComputeEnvironmentDetail) SetType(v string) *ComputeEnvironmentDetail {
// 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 same architecture. Batch doesn't support mixing compute environment architecture
+// types in a single job queue.
type ComputeEnvironmentOrder struct {
_ struct{} `type:"structure"`
@@ -2507,9 +2507,9 @@ func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder {
return s
}
-// An object representing an AWS Batch compute resource. For more information,
-// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
-// in the AWS Batch User Guide.
+// An object representing an Batch compute resource. For more information, see
+// Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
+// in the Batch User Guide.
type ComputeResource struct {
_ struct{} `type:"structure"`
@@ -2518,18 +2518,18 @@ type ComputeResource struct {
// of availability of the instance type in the Region or Amazon EC2 service
// limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html).
// For more information, see Allocation Strategies (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
- // This parameter isn't applicable to jobs running on Fargate resources, and
- // shouldn't be specified.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
//
// BEST_FIT (default)
//
- // AWS Batch selects an instance type that best fits the needs of the jobs with
+ // 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
+ // 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 hitting Amazon EC2 service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html)
+ // if the user is reaching Amazon EC2 service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html)
// 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
@@ -2537,22 +2537,22 @@ type ComputeResource struct {
//
// BEST_FIT_PROGRESSIVE
//
- // 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
+ // 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
+ // selected instance types aren't available, Batch will select new instance
// types.
//
// SPOT_CAPACITY_OPTIMIZED
//
- // 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
+ // 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.
+ // 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.
AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"CRAllocationStrategy"`
// The maximum percentage that a Spot Instance price can be when compared with
@@ -2563,39 +2563,39 @@ type ComputeResource struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
BidPercentage *int64 `locationName:"bidPercentage" type:"integer"`
- // The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch
+ // 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 running on Fargate resources, and
- // shouldn't be specified.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"`
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
Ec2Configuration []*Ec2Configuration `locationName:"ec2Configuration" type:"list"`
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
Ec2KeyPair *string `locationName:"ec2KeyPair" type:"string"`
// 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.
+ // 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.
@@ -2612,10 +2612,10 @@ type ComputeResource struct {
// environment. You can specify the short name or full Amazon Resource Name
// (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam:::instance-profile/ecsInstanceRole
// . For more information, see Amazon ECS Instance Role (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
- // This parameter isn't applicable to jobs running on Fargate resources, and
- // shouldn't be specified.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
InstanceRole *string `locationName:"instanceRole" type:"string"`
// The instances types that can be launched. You can specify instance families
@@ -2624,8 +2624,8 @@ type ComputeResource struct {
// 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.
+ // 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,
@@ -2641,17 +2641,17 @@ type ComputeResource struct {
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
- // This parameter isn't applicable to jobs running on Fargate resources, and
- // shouldn't be specified.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
LaunchTemplate *LaunchTemplateSpecification `locationName:"launchTemplate" type:"structure"`
// 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.
+ // 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.
//
@@ -2661,8 +2661,8 @@ type ComputeResource struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
MinvCpus *int64 `locationName:"minvCpus" type:"integer"`
// The Amazon EC2 placement group to associate with your compute resources.
@@ -2673,65 +2673,66 @@ type ComputeResource struct {
// flow potential. For more information, see Placement Groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
PlacementGroup *string `locationName:"placementGroup" type:"string"`
// 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.
+ // 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.
SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"`
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
- // This parameter isn't applicable to jobs running on Fargate resources, and
- // shouldn't be specified.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
SpotIamFleetRole *string `locationName:"spotIamFleetRole" type:"string"`
- // 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 (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)
+ // 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 (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)
// in the Amazon VPC User Guide.
//
// Subnets is a required field
Subnets []*string `locationName:"subnets" type:"list" required:"true"`
// 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",
+ // 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": "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.
+ // { "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.
Tags map[string]*string `locationName:"tags" type:"map"`
// The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For
// more information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"CRType"`
@@ -2880,29 +2881,29 @@ func (s *ComputeResource) SetType(v string) *ComputeResource {
// An object representing the attributes of a compute environment that can be
// updated. For more information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
-// in the AWS Batch User Guide.
+// in the Batch User Guide.
type ComputeResourceUpdate struct {
_ struct{} `type:"structure"`
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"`
// 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.
+ // 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.
MaxvCpus *int64 `locationName:"maxvCpus" type:"integer"`
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources,
+ // and shouldn't be specified.
MinvCpus *int64 `locationName:"minvCpus" type:"integer"`
// The Amazon EC2 security groups associated with instances launched in the
@@ -2912,7 +2913,7 @@ type ComputeResourceUpdate struct {
// wasn't specified and no change is made.
SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"`
- // The VPC subnets that the compute resources are launched into. Fargate compute
+ // 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
@@ -2975,19 +2976,19 @@ type ContainerDetail struct {
// 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.
+ // is reserved for variables that are set by the Batch service.
Environment []*KeyValuePair `locationName:"environment" type:"list"`
- // The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
- // For more information, see AWS Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)
- // in the AWS Batch User Guide.
+ // The Amazon Resource Name (ARN) of the execution role that Batch can assume.
+ // For more information, see Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)
+ // in the Batch User Guide.
ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`
// The exit code to return upon completion.
ExitCode *int64 `locationName:"exitCode" type:"integer"`
- // The platform configuration for jobs running on Fargate resources. Jobs running
- // on EC2 resources must not specify this parameter.
+ // The platform configuration for jobs that are running on Fargate resources.
+ // Jobs that are running on EC2 resources must not specify this parameter.
FargatePlatformConfiguration *FargatePlatformConfiguration `locationName:"fargatePlatformConfiguration" type:"structure"`
// The image used to start the container.
@@ -2996,7 +2997,7 @@ type ContainerDetail struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources.
InstanceType *string `locationName:"instanceType" type:"string"`
// The Amazon Resource Name (ARN) associated with the job upon execution.
@@ -3021,10 +3022,9 @@ type ContainerDetail struct {
// see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
// 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.
+ // 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
@@ -3040,8 +3040,8 @@ type ContainerDetail struct {
LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"`
// 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 log group for Batch jobs is /aws/batch/job. Each container attempt receives
+ // a log stream name when they reach the RUNNING status.
LogStreamName *string `locationName:"logStreamName" type:"string"`
// For jobs run on EC2 resources that didn't specify memory requirements using
@@ -3052,8 +3052,8 @@ type ContainerDetail struct {
// The mount points for data volumes in your container.
MountPoints []*MountPoint `locationName:"mountPoints" type:"list"`
- // The network configuration for jobs running on Fargate resources. Jobs running
- // on EC2 resources must not specify this parameter.
+ // The network configuration for jobs that are running on Fargate resources.
+ // Jobs that are running on EC2 resources must not specify this parameter.
NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`
// The network interfaces associated with the job.
@@ -3063,8 +3063,8 @@ type ContainerDetail struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided, or specified as false.
Privileged *bool `locationName:"privileged" type:"boolean"`
// When this parameter is true, the container is given read-only access to its
@@ -3084,7 +3084,7 @@ type ContainerDetail struct {
// The secrets to pass to the container. For more information, see Specifying
// sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
Secrets []*Secret `locationName:"secrets" type:"list"`
// The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with
@@ -3097,7 +3097,7 @@ type ContainerDetail struct {
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
// and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/).
//
- // This parameter isn't applicable to jobs running on Fargate resources.
+ // This parameter isn't applicable to jobs that are running on Fargate resources.
Ulimits []*Ulimit `locationName:"ulimits" type:"list"`
// The user name to use inside the container. This parameter maps to User in
@@ -3304,19 +3304,22 @@ type ContainerOverrides struct {
// 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.
+ // is reserved for variables that are set by the Batch service.
Environment []*KeyValuePair `locationName:"environment" type:"list"`
// 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.
+ // This parameter isn't applicable to single-node container jobs or jobs that
+ // run on Fargate resources, and shouldn't be provided.
InstanceType *string `locationName:"instanceType" type:"string"`
// 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.
+ // 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
@@ -3333,12 +3336,10 @@ type ContainerOverrides struct {
// 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.
+ // 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 (https://docs.docker.com/engine/api/v1.23/#create-a-container)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
@@ -3346,9 +3347,10 @@ type ContainerOverrides struct {
// 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 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.
//
// Deprecated: This field is deprecated, use resourceRequirements instead.
Vcpus *int64 `locationName:"vcpus" deprecated:"true" type:"integer"`
@@ -3442,17 +3444,17 @@ type ContainerProperties struct {
// 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.
+ // is reserved for variables that are set by the Batch service.
Environment []*KeyValuePair `locationName:"environment" type:"list"`
- // The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
+ // 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 AWS Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)
- // in the AWS Batch User Guide.
+ // For more information, see Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)
+ // in the Batch User Guide.
ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"`
- // The platform configuration for jobs running on Fargate resources. Jobs running
- // on EC2 resources must not specify this parameter.
+ // The platform configuration for jobs that are running on Fargate resources.
+ // Jobs that are running on EC2 resources must not specify this parameter.
FargatePlatformConfiguration *FargatePlatformConfiguration `locationName:"fargatePlatformConfiguration" type:"structure"`
// The image used to start a container. This string is passed directly to the
@@ -3484,12 +3486,13 @@ type ContainerProperties struct {
// 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.
+ // This parameter isn't applicable to single-node container jobs or jobs that
+ // run on Fargate resources, and shouldn't be provided.
InstanceType *string `locationName:"instanceType" type:"string"`
// 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
+ // for Amazon Web Services permissions. For more information, see IAM Roles
+ // for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
// in the Amazon Elastic Container Service Developer Guide.
JobRoleArn *string `locationName:"jobRoleArn" type:"string"`
@@ -3511,8 +3514,8 @@ type ContainerProperties struct {
// for different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
// 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).
+ // 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
@@ -3528,7 +3531,7 @@ type ContainerProperties struct {
LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"`
// This parameter indicates the memory hard limit (in MiB) for a container.
- // If your container attempts to exceed the specified number, it is terminated.
+ // 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.
@@ -3539,12 +3542,12 @@ type ContainerProperties struct {
//
// 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.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
// Deprecated: This field is deprecated, use resourceRequirements instead.
Memory *int64 `locationName:"memory" deprecated:"true" type:"integer"`
@@ -3555,8 +3558,8 @@ type ContainerProperties struct {
// and the --volume option to docker run (https://docs.docker.com/engine/reference/run/).
MountPoints []*MountPoint `locationName:"mountPoints" type:"list"`
- // The network configuration for jobs running on Fargate resources. Jobs running
- // on EC2 resources must not specify this parameter.
+ // The network configuration for jobs that are running on Fargate resources.
+ // Jobs that are running on EC2 resources must not specify this parameter.
NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`
// When this parameter is true, the container is given elevated permissions
@@ -3566,8 +3569,8 @@ type ContainerProperties struct {
// and the --privileged option to docker run (https://docs.docker.com/engine/reference/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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided, or specified as false.
Privileged *bool `locationName:"privileged" type:"boolean"`
// When this parameter is true, the container is given read-only access to its
@@ -3583,7 +3586,7 @@ type ContainerProperties struct {
// The secrets for the container. For more information, see Specifying sensitive
// data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
Secrets []*Secret `locationName:"secrets" type:"list"`
// A list of ulimits to set in the container. This parameter maps to Ulimits
@@ -3591,8 +3594,8 @@ type ContainerProperties struct {
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
// and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/).
//
- // This parameter isn't applicable to jobs running on Fargate resources and
- // shouldn't be provided.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
Ulimits []*Ulimit `locationName:"ulimits" type:"list"`
// The user name to use inside the container. This parameter maps to User in
@@ -3605,17 +3608,17 @@ type ContainerProperties struct {
// CPU shares. This parameter maps to CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
// and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/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.
+ // 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 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 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.
//
// Deprecated: This field is deprecated, use resourceRequirements instead.
Vcpus *int64 `locationName:"vcpus" deprecated:"true" type:"integer"`
@@ -3861,19 +3864,19 @@ type CreateComputeEnvironmentInput struct {
// Details about the compute resources managed by the compute environment. This
// parameter is required for managed compute environments. For more information,
// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"`
- // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
- // in the AWS Batch User Guide.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
+ // in the 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 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
@@ -3882,9 +3885,9 @@ type CreateComputeEnvironmentInput struct {
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names)
// in the IAM User Guide.
//
- // Depending on how you created your AWS Batch service role, its ARN might contain
+ // 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, AWS Batch assumes that your ARN doesn't use the service-role path prefix.
+ // 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.
ServiceRole *string `locationName:"serviceRole" type:"string"`
@@ -3893,13 +3896,13 @@ type CreateComputeEnvironmentInput struct {
// 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 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 AWS Batch scheduler doesn't attempt to
- // place jobs within the environment. Jobs in a STARTING or RUNNING state continue
+ // 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.
@@ -3907,8 +3910,8 @@ type CreateComputeEnvironmentInput struct {
// 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
- // in AWS General Reference.
+ // For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
+ // in Amazon Web Services General Reference.
//
// These tags can be updated or removed using the TagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html)
// and UntagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html)
@@ -3917,7 +3920,7 @@ type CreateComputeEnvironmentInput struct {
// The type of the compute environment: MANAGED or UNMANAGED. For more information,
// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"CEType"`
@@ -4039,8 +4042,8 @@ type CreateJobQueueInput struct {
// 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 same architecture. Batch doesn't support mixing compute environment architecture
+ // types in a single job queue.
//
// ComputeEnvironmentOrder is a required field
ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list" required:"true"`
@@ -4057,7 +4060,7 @@ type CreateJobQueueInput struct {
// 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.
+ // EC2 and Fargate compute environments can't be mixed.
//
// Priority is a required field
Priority *int64 `locationName:"priority" type:"integer" required:"true"`
@@ -4069,8 +4072,8 @@ type CreateJobQueueInput struct {
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
- // in AWS Batch User Guide.
+ // information, see Tagging your Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
+ // in Batch User Guide.
Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
}
@@ -4439,8 +4442,9 @@ type DescribeJobDefinitionsInput struct {
// The name of the job definition to describe.
JobDefinitionName *string `locationName:"jobDefinitionName" type:"string"`
- // A list of up to 100 job definition names or full Amazon Resource Name (ARN)
- // entries.
+ // 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}.
JobDefinitions []*string `locationName:"jobDefinitions" type:"list"`
// The maximum number of results returned by DescribeJobDefinitions in paginated
@@ -4696,12 +4700,12 @@ func (s *DescribeJobsOutput) SetJobs(v []*JobDetail) *DescribeJobsOutput {
// An object representing a container instance host device.
//
-// This object isn't applicable to jobs running on Fargate resources and shouldn't
-// be provided.
+// This object isn't applicable to jobs that are running on Fargate resources
+// and shouldn't be provided.
type Device struct {
_ struct{} `type:"structure"`
- // The path inside the container used to expose the host device. By default,
+ // The path inside the container that's used to expose the host device. By default,
// the hostPath value is used.
ContainerPath *string `locationName:"containerPath" type:"string"`
@@ -4769,12 +4773,12 @@ type EFSAuthorizationConfig struct {
// in the Amazon Elastic File System User Guide.
AccessPointId *string `locationName:"accessPointId" type:"string"`
- // Whether or not to use the AWS Batch execution IAM role defined in a job definition
+ // 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 (https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html#efs-volume-accesspoints)
- // in the AWS Batch User Guide. EFS IAM authorization requires that TransitEncryption
+ // EFS Access Points (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints)
+ // in the Batch User Guide. EFS IAM authorization requires that TransitEncryption
// be ENABLED and that a JobRoleArn is specified.
Iam *string `locationName:"iam" type:"string" enum:"EFSAuthorizationConfigIAM"`
}
@@ -4801,10 +4805,9 @@ func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig {
return s
}
-// 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
-// (https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html) in the AWS
-// Batch User Guide.
+// This is used when you're using an Amazon Elastic File System file system
+// for job storage. For more information, see Amazon EFS Volumes (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html)
+// in the Batch User Guide.
type EFSVolumeConfiguration struct {
_ struct{} `type:"structure"`
@@ -4818,15 +4821,15 @@ type EFSVolumeConfiguration struct {
// 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.
+ // 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 will enforce
- // the path set on the Amazon EFS access point.
+ // directory parameter must either be omitted or set to /, which enforces the
+ // path set on the Amazon EFS access point.
RootDirectory *string `locationName:"rootDirectory" type:"string"`
- // Whether or not to enable encryption for Amazon EFS data in transit between
+ // 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
@@ -4835,10 +4838,11 @@ type EFSVolumeConfiguration struct {
TransitEncryption *string `locationName:"transitEncryption" type:"string" enum:"EFSTransitEncryption"`
// 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 (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html)
- // in the Amazon Elastic File System User Guide.
+ // 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
+ // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the
+ // Amazon Elastic File System User Guide.
TransitEncryptionPort *int64 `locationName:"transitEncryptionPort" type:"integer"`
}
@@ -4898,10 +4902,10 @@ func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeCon
// 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami))
-// for non-GPU, non-Graviton instances. Starting on March 31, 2021, this default
-// will be changing to ECS_AL2 (Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)).
+// for non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this
+// default will be changing to ECS_AL2 (Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)).
//
-// This object isn't applicable to jobs running on Fargate resources.
+// This object isn't applicable to jobs that are running on Fargate resources.
type Ec2Configuration struct {
_ struct{} `type:"structure"`
@@ -4918,21 +4922,22 @@ type Ec2Configuration struct {
// ECS_AL2
//
// Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)−
- // 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.
+ // 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.
//
// ECS_AL2_NVIDIA
//
// Amazon Linux 2 (GPU) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami)−Default
// for all GPU instance families (for example P4 and G4) and can be used for
- // all non-AWS Graviton-based instance types.
+ // all non Amazon Web Services Graviton-based instance types.
//
// ECS_AL1
//
// Amazon Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami)−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 (http://aws.amazon.com/amazon-linux-ami/).
+ // 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 (http://aws.amazon.com/amazon-linux-ami/).
//
// ImageType is a required field
ImageType *string `locationName:"imageType" min:"1" type:"string" required:"true"`
@@ -4991,20 +4996,20 @@ type EvaluateOnExit struct {
Action *string `locationName:"action" type:"string" required:"true" enum:"RetryAction"`
// 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.
+ // 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.
OnExitCode *string `locationName:"onExitCode" type:"string"`
// 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,
+ // 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.
OnReason *string `locationName:"onReason" type:"string"`
// 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,
+ // 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.
@@ -5058,16 +5063,16 @@ func (s *EvaluateOnExit) SetOnStatusReason(v string) *EvaluateOnExit {
return s
}
-// The platform configuration for jobs running on Fargate resources. For jobs
-// that run on EC2 resources, you shouldn't specify this parameter.
+// The platform configuration for jobs that are running on Fargate resources.
+// Jobs that run on EC2 resources must not specify this parameter.
type FargatePlatformConfiguration struct {
_ struct{} `type:"structure"`
- // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
+ // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
PlatformVersion *string `locationName:"platformVersion" type:"string"`
}
@@ -5124,7 +5129,7 @@ func (s *Host) SetSourcePath(v string) *Host {
return s
}
-// An object representing an AWS Batch job definition.
+// An object representing an Batch job definition.
type JobDefinition struct {
_ struct{} `type:"structure"`
@@ -5152,7 +5157,7 @@ type JobDefinition struct {
// Parameters in a SubmitJob request override any corresponding parameter defaults
// from the job definition. For more information about specifying parameters,
// see Job Definition Parameters (https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
Parameters map[string]*string `locationName:"parameters" type:"map"`
// The platform capabilities required by the job definition. If no value is
@@ -5183,14 +5188,14 @@ type JobDefinition struct {
Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
// 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.
+ // You can specify a timeout duration after which Batch terminates your jobs
+ // if they haven't finished.
Timeout *JobTimeout `locationName:"timeout" type:"structure"`
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true"`
@@ -5284,11 +5289,11 @@ func (s *JobDefinition) SetType(v string) *JobDefinition {
return s
}
-// An object representing an AWS Batch job dependency.
+// An object representing an Batch job dependency.
type JobDependency struct {
_ struct{} `type:"structure"`
- // The job ID of the AWS Batch job associated with this dependency.
+ // The job ID of the Batch job associated with this dependency.
JobId *string `locationName:"jobId" type:"string"`
// The type of the job dependency.
@@ -5317,7 +5322,7 @@ func (s *JobDependency) SetType(v string) *JobDependency {
return s
}
-// An object representing an AWS Batch job.
+// An object representing an Batch job.
type JobDetail struct {
_ struct{} `type:"structure"`
@@ -5370,7 +5375,7 @@ type JobDetail struct {
// An object representing the node properties of a multi-node parallel job.
//
- // This isn't applicable to jobs running on Fargate resources.
+ // This isn't applicable to jobs that are running on Fargate resources.
NodeProperties *NodeProperties `locationName:"nodeProperties" type:"structure"`
// Additional parameters passed to the job that replace parameter substitution
@@ -5404,7 +5409,7 @@ type JobDetail struct {
//
// If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status
// (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable)
- // in the troubleshooting section of the AWS Batch User Guide.
+ // in the troubleshooting section of the Batch User Guide.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"`
@@ -5567,7 +5572,7 @@ func (s *JobDetail) SetTimeout(v *JobTimeout) *JobDetail {
return s
}
-// An object representing the details of an AWS Batch job queue.
+// An object representing the details of an Batch job queue.
type JobQueueDetail struct {
_ struct{} `type:"structure"`
@@ -5614,8 +5619,8 @@ type JobQueueDetail struct {
StatusReason *string `locationName:"statusReason" type:"string"`
// The tags applied to the job queue. For more information, see Tagging your
- // AWS Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
- // in AWS Batch User Guide.
+ // Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
+ // in Batch User Guide.
Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
}
@@ -5697,6 +5702,9 @@ type JobSummary struct {
// The Amazon Resource Name (ARN) of the job.
JobArn *string `locationName:"jobArn" type:"string"`
+ // The Amazon Resource Name (ARN) of the job definition.
+ JobDefinition *string `locationName:"jobDefinition" type:"string"`
+
// The ID of the job.
//
// JobId is a required field
@@ -5709,7 +5717,7 @@ type JobSummary struct {
// The node properties for a single node in a job summary list.
//
- // This isn't applicable to jobs running on Fargate resources.
+ // This isn't applicable to jobs that are running on Fargate resources.
NodeProperties *NodePropertiesSummary `locationName:"nodeProperties" type:"structure"`
// The Unix timestamp for when the job was started (when the job transitioned
@@ -5762,6 +5770,12 @@ func (s *JobSummary) SetJobArn(v string) *JobSummary {
return s
}
+// SetJobDefinition sets the JobDefinition field's value.
+func (s *JobSummary) SetJobDefinition(v string) *JobSummary {
+ s.JobDefinition = &v
+ return s
+}
+
// SetJobId sets the JobId field's value.
func (s *JobSummary) SetJobId(v string) *JobSummary {
s.JobId = &v
@@ -5809,8 +5823,8 @@ type JobTimeout struct {
_ struct{} `type:"structure"`
// 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.
+ // after which Batch terminates your jobs if they have not finished. The minimum
+ // value for the timeout is 60 seconds.
AttemptDurationSeconds *int64 `locationName:"attemptDurationSeconds" type:"integer"`
}
@@ -5865,6 +5879,40 @@ func (s *KeyValuePair) SetValue(v string) *KeyValuePair {
return s
}
+// A filter name and value pair that's used to return a more specific list of
+// results from a ListJobs API operation.
+type KeyValuesPair struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the filter. Filter names are case sensitive.
+ Name *string `locationName:"name" type:"string"`
+
+ // The filter values.
+ Values []*string `locationName:"values" type:"list"`
+}
+
+// String returns the string representation
+func (s KeyValuesPair) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s KeyValuesPair) GoString() string {
+ return s.String()
+}
+
+// SetName sets the Name field's value.
+func (s *KeyValuesPair) SetName(v string) *KeyValuesPair {
+ s.Name = &v
+ return s
+}
+
+// SetValues sets the Values field's value.
+func (s *KeyValuesPair) SetValues(v []*string) *KeyValuesPair {
+ s.Values = v
+ return s
+}
+
// 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.
@@ -5873,7 +5921,7 @@ func (s *KeyValuePair) SetValue(v string) *KeyValuePair {
// 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.
+// This object isn't applicable to jobs that are running on Fargate resources.
type LaunchTemplateSpecification struct {
_ struct{} `type:"structure"`
@@ -5888,8 +5936,8 @@ type LaunchTemplateSpecification struct {
// 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
+ // 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
@@ -5937,8 +5985,8 @@ type LinuxParameters struct {
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
// and the --device option to docker run (https://docs.docker.com/engine/reference/run/).
//
- // This parameter isn't applicable to jobs running on Fargate resources and
- // shouldn't be provided.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
Devices []*Device `locationName:"devices" type:"list"`
// If true, run an init process inside the container that forwards signals and
@@ -5961,22 +6009,22 @@ type LinuxParameters struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
MaxSwap *int64 `locationName:"maxSwap" type:"integer"`
// The value for the size (in MiB) of the /dev/shm volume. This parameter maps
// to the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/).
//
- // This parameter isn't applicable to jobs running on Fargate resources and
- // shouldn't be provided.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
SharedMemorySize *int64 `locationName:"sharedMemorySize" type:"integer"`
// 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
+ // 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 (https://docs.docker.com/engine/reference/run/).
@@ -5999,15 +6047,15 @@ type LinuxParameters struct {
// 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 parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
Swappiness *int64 `locationName:"swappiness" type:"integer"`
// The container path, mount options, and size (in MiB) of the tmpfs mount.
// This parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/).
//
- // This parameter isn't applicable to jobs running on Fargate resources and
- // shouldn't be provided.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"`
}
@@ -6095,12 +6143,55 @@ type ListJobsInput struct {
// lists all child jobs from within the specified array.
ArrayJobId *string `locationName:"arrayJobId" type:"string"`
+ // 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.
+ //
+ // JOB_NAME
+ //
+ // 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.
+ //
+ // JOB_DEFINITION
+ //
+ // 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.
+ //
+ // BEFORE_CREATED_AT
+ //
+ // 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.
+ //
+ // AFTER_CREATED_AT
+ //
+ // 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.
+ Filters []*KeyValuesPair `locationName:"filters" type:"list"`
+
// The name or full Amazon Resource Name (ARN) of the job queue used to list
// jobs.
JobQueue *string `locationName:"jobQueue" type:"string"`
- // 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.
JobStatus *string `locationName:"jobStatus" type:"string" enum:"JobStatus"`
// The maximum number of results returned by ListJobs in paginated output. When
@@ -6142,6 +6233,12 @@ func (s *ListJobsInput) SetArrayJobId(v string) *ListJobsInput {
return s
}
+// SetFilters sets the Filters field's value.
+func (s *ListJobsInput) SetFilters(v []*KeyValuesPair) *ListJobsInput {
+ s.Filters = v
+ return s
+}
+
// SetJobQueue sets the JobQueue field's value.
func (s *ListJobsInput) SetJobQueue(v string) *ListJobsInput {
s.JobQueue = &v
@@ -6213,8 +6310,8 @@ type ListTagsForResourceInput struct {
_ struct{} `type:"structure"`
// 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
+ // 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.
//
// ResourceArn is a required field
@@ -6287,14 +6384,14 @@ type LogConfiguration struct {
// 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.
+ // Jobs that are running on Fargate resources are restricted to the awslogs
+ // and splunk log drivers.
//
// awslogs
//
// Specifies the Amazon CloudWatch Logs logging driver. For more information,
// see Using the awslogs Log Driver (https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html)
- // in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver (https://docs.docker.com/config/containers/logging/awslogs/)
+ // in the Batch User Guide and Amazon CloudWatch Logs logging driver (https://docs.docker.com/config/containers/logging/awslogs/)
// in the Docker documentation.
//
// fluentd
@@ -6357,7 +6454,7 @@ type LogConfiguration struct {
// The secrets to pass to the log configuration. For more information, see Specifying
// Sensitive Data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
SecretOptions []*Secret `locationName:"secretOptions" type:"list"`
}
@@ -6457,14 +6554,14 @@ func (s *MountPoint) SetSourceVolume(v string) *MountPoint {
return s
}
-// The network configuration for jobs running on Fargate resources. Jobs running
-// on EC2 resources must not specify this parameter.
+// The network configuration for jobs that are running on Fargate resources.
+// Jobs that are running on EC2 resources must not specify this parameter.
type NetworkConfiguration struct {
_ struct{} `type:"structure"`
- // 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
+ // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html).
// The default value is "DISABLED".
@@ -6569,7 +6666,7 @@ func (s *NodeDetails) SetNodeIndex(v int64) *NodeDetails {
// 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
+// This isn't applicable to jobs that are running on Fargate resources and shouldn't
// be provided; use containerOverrides instead.
type NodeOverrides struct {
_ struct{} `type:"structure"`
@@ -6898,7 +6995,7 @@ type RegisterJobDefinitionInput struct {
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html)
- // in the AWS Batch User Guide. If the job definition's type parameter is container,
+ // 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;
@@ -6931,22 +7028,22 @@ type RegisterJobDefinitionInput struct {
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
- // in AWS Batch User Guide.
+ // For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html)
+ // in Batch User Guide.
Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html)
- // in the AWS Batch User Guide.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html)
+ // in the Batch User Guide.
Timeout *JobTimeout `locationName:"timeout" type:"structure"`
// The type of job definition. For more information about multi-node parallel
// jobs, see Creating a multi-node parallel job definition (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
//
// If the job is run on Fargate resources, then multinode isn't supported.
//
@@ -7125,13 +7222,13 @@ type ResourceRequirement struct {
// 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.
+ // GPUs are not available for jobs that are running on Fargate resources.
//
// type="MEMORY"
//
// 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
+ // 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 (https://docs.docker.com/engine/api/v1.23/#create-a-container)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/).
@@ -7145,11 +7242,11 @@ type ResourceRequirement struct {
// 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 (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html)
- // in the AWS Batch User Guide.
+ // in the 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.
+ // 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.
//
// value = 512
//
@@ -7198,9 +7295,9 @@ type ResourceRequirement struct {
// 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
+ // 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
//
// value = 0.25
//
@@ -7269,7 +7366,7 @@ func (s *ResourceRequirement) SetValue(v string) *ResourceRequirement {
// The retry strategy associated with a job. For more information, see Automated
// job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html)
-// in the AWS Batch User Guide.
+// in the Batch User Guide.
type RetryStrategy struct {
_ struct{} `type:"structure"`
@@ -7336,7 +7433,7 @@ func (s *RetryStrategy) SetEvaluateOnExit(v []*EvaluateOnExit) *RetryStrategy {
// use the secretOptions container definition parameter.
//
// For more information, see Specifying sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html)
-// in the AWS Batch User Guide.
+// in the Batch User Guide.
type Secret struct {
_ struct{} `type:"structure"`
@@ -7346,13 +7443,13 @@ type Secret struct {
Name *string `locationName:"name" type:"string" required:"true"`
// 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.
+ // 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 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.
+ // 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.
//
// ValueFrom is a required field
ValueFrom *string `locationName:"valueFrom" type:"string" required:"true"`
@@ -7460,7 +7557,7 @@ type SubmitJobInput struct {
// 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
// (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the
- // AWS Batch User Guide.
+ // Batch User Guide.
ArrayProperties *ArrayProperties `locationName:"arrayProperties" type:"structure"`
// A list of container overrides in the JSON format that specify the name of
@@ -7503,8 +7600,8 @@ type SubmitJobInput struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources;
+ // use containerOverrides instead.
NodeOverrides *NodeOverrides `locationName:"nodeOverrides" type:"structure"`
// Additional parameters passed to the job that replace parameter substitution
@@ -7529,17 +7626,17 @@ type SubmitJobInput struct {
// 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
- // in AWS General Reference.
+ // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
+ // in Amazon Web Services General Reference.
Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
// 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
+ // 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
+ // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
// in the Amazon Elastic Container Service Developer Guide.
Timeout *JobTimeout `locationName:"timeout" type:"structure"`
}
@@ -7711,8 +7808,8 @@ func (s *SubmitJobOutput) SetJobName(v string) *SubmitJobOutput {
type TagResourceInput struct {
_ struct{} `type:"structure"`
- // 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,
+ // 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.
//
@@ -7721,8 +7818,8 @@ type TagResourceInput struct {
// 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
- // in AWS General Reference.
+ // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
+ // in Amazon Web Services General Reference.
//
// Tags is a required field
Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
@@ -7790,14 +7887,14 @@ func (s TagResourceOutput) GoString() string {
type TerminateJobInput struct {
_ struct{} `type:"structure"`
- // The AWS Batch job ID of the job to terminate.
+ // The Batch job ID of the job to terminate.
//
// JobId is a required field
JobId *string `locationName:"jobId" type:"string" required:"true"`
// 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.
+ // message is also recorded in the Batch activity logs.
//
// Reason is a required field
Reason *string `locationName:"reason" type:"string" required:"true"`
@@ -7857,7 +7954,7 @@ func (s TerminateJobOutput) GoString() string {
// The container path, mount options, and size of the tmpfs mount.
//
-// This object isn't applicable to jobs running on Fargate resources.
+// This object isn't applicable to jobs that are running on Fargate resources.
type Tmpfs struct {
_ struct{} `type:"structure"`
@@ -7928,7 +8025,7 @@ func (s *Tmpfs) SetSize(v int64) *Tmpfs {
// The ulimit settings to pass to the container.
//
-// This object isn't applicable to jobs running on Fargate resources.
+// This object isn't applicable to jobs that are running on Fargate resources.
type Ulimit struct {
_ struct{} `type:"structure"`
@@ -7999,9 +8096,9 @@ type UntagResourceInput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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.
//
// ResourceArn is a required field
ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
@@ -8083,25 +8180,25 @@ type UpdateComputeEnvironmentInput struct {
// Details of the compute resources managed by the compute environment. Required
// for a managed compute environment. For more information, see Compute Environments
// (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html)
- // in the AWS Batch User Guide.
+ // in the Batch User Guide.
ComputeResources *ComputeResourceUpdate `locationName:"computeResources" type:"structure"`
- // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
- // in the AWS Batch User Guide.
+ // 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 (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html)
+ // in the 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 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 AWS Batch service role, its ARN might contain
+ // 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, AWS Batch assumes that your ARN doesn't use the service-role path prefix.
+ // 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.
ServiceRole *string `locationName:"serviceRole" type:"string"`
@@ -8110,13 +8207,13 @@ type UpdateComputeEnvironmentInput struct {
// 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 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 AWS Batch scheduler doesn't attempt to
- // place jobs within the environment. Jobs in a STARTING or RUNNING state continue
+ // 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.
@@ -8216,8 +8313,8 @@ type UpdateJobQueueInput struct {
// 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 same architecture. Batch doesn't support mixing compute environment architecture
+ // types in a single job queue.
ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list"`
// The name or the Amazon Resource Name (ARN) of the job queue.
@@ -8334,8 +8431,8 @@ type Volume struct {
_ struct{} `type:"structure"`
// 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.
+ // file system for job storage. Jobs that are running on Fargate resources must
+ // specify a platformVersion of at least 1.4.0.
EfsVolumeConfiguration *EFSVolumeConfiguration `locationName:"efsVolumeConfiguration" type:"structure"`
// The contents of the host parameter determine whether your data volume persists
@@ -8344,8 +8441,8 @@ type Volume struct {
// 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.
+ // This parameter isn't applicable to jobs that are running on Fargate resources
+ // and shouldn't be provided.
Host *Host `locationName:"host" type:"structure"`
// The name of the volume. Up to 255 letters (uppercase and lowercase), numbers,
diff --git a/service/batch/doc.go b/service/batch/doc.go
index 50b23d93b8..9997af377f 100644
--- a/service/batch/doc.go
+++ b/service/batch/doc.go
@@ -3,20 +3,20 @@
// Package batch provides the client and types for making API
// requests to AWS Batch.
//
-// 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.
+// 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.
//
diff --git a/service/iotanalytics/api.go b/service/iotanalytics/api.go
index f6e3a14c85..e784236f51 100644
--- a/service/iotanalytics/api.go
+++ b/service/iotanalytics/api.go
@@ -240,8 +240,8 @@ func (c *IoTAnalytics) CreateChannelRequest(input *CreateChannelInput) (req *req
// CreateChannel API operation for AWS IoT Analytics.
//
-// Creates a channel. A channel collects data from an MQTT topic and archives
-// the raw, unprocessed messages before publishing the data to a pipeline.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -335,11 +335,11 @@ func (c *IoTAnalytics) CreateDatasetRequest(input *CreateDatasetInput) (req *req
// CreateDataset API operation for AWS IoT Analytics.
//
-// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -433,7 +433,7 @@ func (c *IoTAnalytics) CreateDatasetContentRequest(input *CreateDatasetContentIn
// CreateDatasetContent API operation for AWS IoT Analytics.
//
-// Creates the content of a data set by applying a queryAction (a SQL query)
+// Creates the content of a dataset by applying a queryAction (a SQL query)
// or a containerAction (executing a containerized application).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -525,8 +525,7 @@ func (c *IoTAnalytics) CreateDatastoreRequest(input *CreateDatastoreInput) (req
// CreateDatastore API operation for AWS IoT Analytics.
//
-// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1453,7 +1452,7 @@ func (c *IoTAnalytics) DescribeLoggingOptionsRequest(input *DescribeLoggingOptio
// DescribeLoggingOptions API operation for AWS IoT Analytics.
//
-// Retrieves the current settings of the AWS IoT Analytics logging options.
+// Retrieves the current settings of the IoT Analytics logging options.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1635,7 +1634,7 @@ func (c *IoTAnalytics) GetDatasetContentRequest(input *GetDatasetContentInput) (
// GetDatasetContent API operation for AWS IoT Analytics.
//
-// Retrieves the contents of a data set as presigned URIs.
+// Retrieves the contents of a dataset as presigned URIs.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1878,7 +1877,7 @@ func (c *IoTAnalytics) ListDatasetContentsRequest(input *ListDatasetContentsInpu
// ListDatasetContents API operation for AWS IoT Analytics.
//
-// Lists information about data set contents that have been created.
+// Lists information about dataset contents that have been created.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2027,7 +2026,7 @@ func (c *IoTAnalytics) ListDatasetsRequest(input *ListDatasetsInput) (req *reque
// ListDatasets API operation for AWS IoT Analytics.
//
-// Retrieves information about data sets.
+// Retrieves information about datasets.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2554,7 +2553,7 @@ func (c *IoTAnalytics) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) (
// PutLoggingOptions API operation for AWS IoT Analytics.
//
-// Sets or updates the AWS IoT Analytics logging options.
+// 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
@@ -3113,7 +3112,7 @@ func (c *IoTAnalytics) UpdateChannelRequest(input *UpdateChannelInput) (req *req
// UpdateChannel API operation for AWS IoT Analytics.
//
-// Updates the settings of a channel.
+// Used to update the settings of a channel.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3205,7 +3204,7 @@ func (c *IoTAnalytics) UpdateDatasetRequest(input *UpdateDatasetInput) (req *req
// UpdateDataset API operation for AWS IoT Analytics.
//
-// Updates the settings of a data set.
+// Updates the settings of a dataset.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3297,7 +3296,7 @@ func (c *IoTAnalytics) UpdateDatastoreRequest(input *UpdateDatastoreInput) (req
// UpdateDatastore API operation for AWS IoT Analytics.
//
-// Updates the settings of a data store.
+// Used to update the settings of a data store.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3571,7 +3570,7 @@ type BatchPutMessageInput struct {
// 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:
+ // 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.
@@ -3753,7 +3752,7 @@ type Channel struct {
// 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.
+ // 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
@@ -3773,7 +3772,7 @@ type Channel struct {
Status *string `locationName:"status" type:"string" enum:"ChannelStatus"`
// Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3
- // storage. If not specified, the default is serviceManagedS3. You cannot change
+ // storage. If not specified, the default is serviceManagedS3. You can't change
// this storage option after the channel is created.
Storage *ChannelStorage `locationName:"storage" type:"structure"`
}
@@ -3973,21 +3972,19 @@ func (s *ChannelStatistics) SetSize(v *EstimatedResourceSize) *ChannelStatistics
return s
}
-// Where channel data is stored. You may choose one of serviceManagedS3 or customerManagedS3
-// storage. If not specified, the default is serviceManagedS3. This cannot be
+// 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.
type ChannelStorage struct {
_ struct{} `type:"structure"`
- // 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.
CustomerManagedS3 *CustomerManagedChannelS3Storage `locationName:"customerManagedS3" type:"structure"`
- // 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.
+ // 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.
ServiceManagedS3 *ServiceManagedChannelS3Storage `locationName:"serviceManagedS3" type:"structure"`
}
@@ -4035,7 +4032,7 @@ type ChannelStorageSummary struct {
// Used to store channel data in an S3 bucket that you manage.
CustomerManagedS3 *CustomerManagedChannelS3StorageSummary `locationName:"customerManagedS3" type:"structure"`
- // Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
+ // Used to store channel data in an S3 bucket managed by IoT Analytics.
ServiceManagedS3 *ServiceManagedChannelS3StorageSummary `locationName:"serviceManagedS3" type:"structure"`
}
@@ -4076,7 +4073,7 @@ type ChannelSummary struct {
// 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.
+ // 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
@@ -4147,7 +4144,7 @@ type Column struct {
// The type of data. For more information about the supported data types, see
// Common data types (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html)
- // in the AWS Glue Developer Guide.
+ // in the Glue Developer Guide.
//
// Type is a required field
Type *string `locationName:"type" min:"1" type:"string" required:"true"`
@@ -4308,7 +4305,7 @@ type CreateChannelInput struct {
ChannelName *string `locationName:"channelName" min:"1" type:"string" required:"true"`
// Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3
- // storage. If not specified, the default is serviceManagedS3. You cannot change
+ // storage. If not specified, the default is serviceManagedS3. You can't change
// this storage option after the channel is created.
ChannelStorage *ChannelStorage `locationName:"channelStorage" type:"structure"`
@@ -4515,7 +4512,7 @@ func (s *CreateDatasetContentOutput) SetVersionId(v string) *CreateDatasetConten
type CreateDatasetInput struct {
_ struct{} `type:"structure"`
- // A list of actions that create the data set contents.
+ // A list of actions that create the dataset contents.
//
// Actions is a required field
Actions []*DatasetAction `locationName:"actions" min:"1" type:"list" required:"true"`
@@ -4524,14 +4521,13 @@ type CreateDatasetInput struct {
// here.
ContentDeliveryRules []*DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`
- // The name of the data set.
+ // The name of the dataset.
//
// DatasetName is a required field
DatasetName *string `locationName:"datasetName" min:"1" type:"string" required:"true"`
- // A list of data rules that send notifications to Amazon CloudWatch, when data
- // arrives late. To specify lateDataRules, the dataset must use a DeltaTimer
- // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
+ // A list of data rules that send notifications to CloudWatch, when data arrives
+ // late. To specify lateDataRules, the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
// filter.
LateDataRules []*LateDataRule `locationName:"lateDataRules" min:"1" type:"list"`
@@ -4539,25 +4535,24 @@ type CreateDatasetInput struct {
// 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
- // (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
- // in the AWS IoT Analytics User Guide.
+ // information, see Keeping Multiple Versions of IoT Analytics datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
+ // in the IoT Analytics User Guide.
RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
- // Metadata which can be used to manage the data set.
+ // Metadata which can be used to manage the dataset.
Tags []*Tag `locationName:"tags" min:"1" type:"list"`
- // 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.
+ // 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.
Triggers []*DatasetTrigger `locationName:"triggers" type:"list"`
// 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 (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
- // in the AWS IoT Analytics User Guide.
+ // parameter. For more information, see Keeping Multiple Versions of IoT Analytics
+ // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
+ // in the IoT Analytics User Guide.
VersioningConfiguration *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
}
@@ -4756,16 +4751,17 @@ type CreateDatastoreInput struct {
// DatastoreName is a required field
DatastoreName *string `locationName:"datastoreName" min:"1" type:"string" required:"true"`
- // Contains information about the partitions in a data store.
+ // Contains information about the partition dimensions in a data store.
DatastorePartitions *DatastorePartitions `locationName:"datastorePartitions" type:"structure"`
- // 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.
DatastoreStorage *DatastoreStorage `locationName:"datastoreStorage" type:"structure"`
- // Contains the configuration information of file formats. AWS IoT Analytics
- // data stores support JSON and Parquet (https://parquet.apache.org/).
+ // Contains the configuration information of file formats. IoT Analytics data
+ // stores support JSON and Parquet (https://parquet.apache.org/).
//
// The default file format is JSON. You can specify only one format.
//
@@ -4921,7 +4917,7 @@ type CreatePipelineInput struct {
// 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
+ // messages based on attribute values; invoking your Lambda unctions on messages
// for advanced processing; or performing mathematical transformations to normalize
// device data.
//
@@ -5049,10 +5045,9 @@ func (s *CreatePipelineOutput) SetPipelineName(v string) *CreatePipelineOutput {
return s
}
-// 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.
type CustomerManagedChannelS3Storage struct {
_ struct{} `type:"structure"`
@@ -5061,14 +5056,14 @@ type CustomerManagedChannelS3Storage struct {
// Bucket is a required field
Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`
- // Optional. The prefix used to create the keys of the channel data objects.
+ // (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 (/).
KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
- // The ARN of the role that grants AWS IoT Analytics permission to interact
- // with your Amazon S3 resources.
+ // The ARN of the role that grants IoT Analytics permission to interact with
+ // your Amazon S3 resources.
//
// RoleArn is a required field
RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
@@ -5134,14 +5129,14 @@ type CustomerManagedChannelS3StorageSummary struct {
// The name of the S3 bucket in which channel data is stored.
Bucket *string `locationName:"bucket" min:"3" type:"string"`
- // Optional. The prefix used to create the keys of the channel data objects.
+ // (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 (/).
KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
- // The ARN of the role that grants AWS IoT Analytics permission to interact
- // with your Amazon S3 resources.
+ // The ARN of the role that grants IoT Analytics permission to interact with
+ // your Amazon S3 resources.
RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
}
@@ -5173,26 +5168,25 @@ func (s *CustomerManagedChannelS3StorageSummary) SetRoleArn(v string) *CustomerM
return s
}
-// 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.
type CustomerManagedDatastoreS3Storage struct {
_ struct{} `type:"structure"`
- // The name of the S3 bucket in which data store data is stored.
+ // The name of the Amazon S3 bucket where your data is stored.
//
// Bucket is a required field
Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`
- // 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 (/).
+ // (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 (/).
KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
- // The ARN of the role that grants AWS IoT Analytics permission to interact
- // with your Amazon S3 resources.
+ // The ARN of the role that grants IoT Analytics permission to interact with
+ // your Amazon S3 resources.
//
// RoleArn is a required field
RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
@@ -5251,21 +5245,21 @@ func (s *CustomerManagedDatastoreS3Storage) SetRoleArn(v string) *CustomerManage
return s
}
-// Used to store data store data in an S3 bucket that you manage.
+// Contains information about the data store that you manage.
type CustomerManagedDatastoreS3StorageSummary struct {
_ struct{} `type:"structure"`
- // The name of the S3 bucket in which data store data is stored.
+ // The name of the Amazon S3 bucket where your data is stored.
Bucket *string `locationName:"bucket" min:"3" type:"string"`
- // 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 (/).
+ // (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 (/).
KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
- // The ARN of the role that grants AWS IoT Analytics permission to interact
- // with your Amazon S3 resources.
+ // The ARN of the role that grants IoT Analytics permission to interact with
+ // your Amazon S3 resources.
RoleArn *string `locationName:"roleArn" min:"20" type:"string"`
}
@@ -5297,51 +5291,50 @@ func (s *CustomerManagedDatastoreS3StorageSummary) SetRoleArn(v string) *Custome
return s
}
-// Information about a data set.
+// Information about a dataset.
type Dataset struct {
_ struct{} `type:"structure"`
- // The DatasetAction objects that automatically create the data set contents.
+ // The DatasetAction objects that automatically create the dataset contents.
Actions []*DatasetAction `locationName:"actions" min:"1" type:"list"`
- // The ARN of the data set.
+ // The ARN of the dataset.
Arn *string `locationName:"arn" type:"string"`
// When dataset contents are created they are delivered to destinations specified
// here.
ContentDeliveryRules []*DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`
- // When the data set was created.
+ // When the dataset was created.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
- // The last time the data set was updated.
+ // The last time the dataset was updated.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
- // A list of data rules that send notifications to Amazon CloudWatch, when data
- // arrives late. To specify lateDataRules, the dataset must use a DeltaTimer
- // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
+ // A list of data rules that send notifications to CloudWatch, when data arrives
+ // late. To specify lateDataRules, the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
// filter.
LateDataRules []*LateDataRule `locationName:"lateDataRules" min:"1" type:"list"`
- // The name of the data set.
+ // The name of the dataset.
Name *string `locationName:"name" min:"1" type:"string"`
- // Optional. How long, in days, message data is kept for the data set.
+ // Optional. How long, in days, message data is kept for the dataset.
RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
- // The status of the data set.
+ // The status of the dataset.
Status *string `locationName:"status" type:"string" enum:"DatasetStatus"`
- // The DatasetTrigger objects that specify when the data set is automatically
+ // The DatasetTrigger objects that specify when the dataset is automatically
// updated.
Triggers []*DatasetTrigger `locationName:"triggers" type:"list"`
// 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 (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
- // in the AWS IoT Analytics User Guide.
+ // parameter. For more information, see Keeping Multiple Versions of IoT Analytics
+ // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
+ // in the IoT Analytics User Guide.
VersioningConfiguration *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
}
@@ -5421,12 +5414,12 @@ func (s *Dataset) SetVersioningConfiguration(v *VersioningConfiguration) *Datase
return s
}
-// A DatasetAction object that specifies how data set contents are automatically
+// A DatasetAction object that specifies how dataset contents are automatically
// created.
type DatasetAction struct {
_ struct{} `type:"structure"`
- // The name of the data set action by which data set contents are automatically
+ // The name of the dataset action by which dataset contents are automatically
// created.
ActionName *string `locationName:"actionName" min:"1" type:"string"`
@@ -5436,7 +5429,7 @@ type DatasetAction struct {
ContainerAction *ContainerDatasetAction `locationName:"containerAction" type:"structure"`
// An SqlQueryDatasetAction object that uses an SQL query to automatically create
- // data set contents.
+ // dataset contents.
QueryAction *SqlQueryDatasetAction `locationName:"queryAction" type:"structure"`
}
@@ -5528,7 +5521,7 @@ func (s *DatasetActionSummary) SetActionType(v string) *DatasetActionSummary {
type DatasetContentDeliveryDestination struct {
_ struct{} `type:"structure"`
- // Configuration information for delivery of dataset contents to AWS IoT Events.
+ // Configuration information for delivery of dataset contents to IoT Events.
IotEventsDestinationConfiguration *IotEventsDestinationConfiguration `locationName:"iotEventsDestinationConfiguration" type:"structure"`
// Configuration information for delivery of dataset contents to Amazon S3.
@@ -5631,14 +5624,14 @@ func (s *DatasetContentDeliveryRule) SetEntryName(v string) *DatasetContentDeliv
return s
}
-// The state of the data set contents and the reason they are in this state.
+// The state of the dataset contents and the reason they are in this state.
type DatasetContentStatus struct {
_ struct{} `type:"structure"`
- // The reason the data set contents are in this state.
+ // The reason the dataset contents are in this state.
Reason *string `locationName:"reason" type:"string"`
- // The state of the data set contents. Can be one of READY, CREATING, SUCCEEDED,
+ // The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED,
// or FAILED.
State *string `locationName:"state" type:"string" enum:"DatasetContentState"`
}
@@ -5678,7 +5671,7 @@ type DatasetContentSummary struct {
// The time the creation of the dataset contents was scheduled to start.
ScheduleTime *time.Time `locationName:"scheduleTime" type:"timestamp"`
- // The status of the data set contents.
+ // The status of the dataset contents.
Status *DatasetContentStatus `locationName:"status" type:"structure"`
// The version of the dataset contents.
@@ -5768,14 +5761,14 @@ func (s *DatasetContentVersionValue) SetDatasetName(v string) *DatasetContentVer
return s
}
-// The reference to a data set entry.
+// The reference to a dataset entry.
type DatasetEntry struct {
_ struct{} `type:"structure"`
- // The presigned URI of the data set item.
+ // The presigned URI of the dataset item.
DataURI *string `locationName:"dataURI" type:"string"`
- // The name of the data set item.
+ // The name of the dataset item.
EntryName *string `locationName:"entryName" type:"string"`
}
@@ -5801,28 +5794,28 @@ func (s *DatasetEntry) SetEntryName(v string) *DatasetEntry {
return s
}
-// A summary of information about a data set.
+// A summary of information about a dataset.
type DatasetSummary struct {
_ struct{} `type:"structure"`
// A list of DataActionSummary objects.
Actions []*DatasetActionSummary `locationName:"actions" min:"1" type:"list"`
- // The time the data set was created.
+ // The time the dataset was created.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
- // The name of the data set.
+ // The name of the dataset.
DatasetName *string `locationName:"datasetName" min:"1" type:"string"`
- // The last time the data set was updated.
+ // The last time the dataset was updated.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
- // The status of the data set.
+ // The status of the dataset.
Status *string `locationName:"status" type:"string" enum:"DatasetStatus"`
- // 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
Triggers []*DatasetTrigger `locationName:"triggers" type:"list"`
}
@@ -5872,11 +5865,11 @@ func (s *DatasetSummary) SetTriggers(v []*DatasetTrigger) *DatasetSummary {
return s
}
-// The DatasetTrigger that specifies when the data set is automatically updated.
+// The DatasetTrigger that specifies when the dataset is automatically updated.
type DatasetTrigger struct {
_ struct{} `type:"structure"`
- // The data set whose content creation triggers the creation of this data set's
+ // The dataset whose content creation triggers the creation of this dataset's
// contents.
Dataset *TriggeringDataset `locationName:"dataset" type:"structure"`
@@ -5931,11 +5924,11 @@ type Datastore struct {
// When the data store was created.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
- // Contains information about the partitions in a data store.
+ // Contains information about the partition dimensions in a data store.
DatastorePartitions *DatastorePartitions `locationName:"datastorePartitions" type:"structure"`
- // Contains the configuration information of file formats. AWS IoT Analytics
- // data stores support JSON and Parquet (https://parquet.apache.org/).
+ // Contains the configuration information of file formats. IoT Analytics data
+ // stores support JSON and Parquet (https://parquet.apache.org/).
//
// The default file format is JSON. You can specify only one format.
//
@@ -5944,8 +5937,9 @@ type Datastore struct {
// 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.
+ // 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.
@@ -5976,9 +5970,10 @@ type Datastore struct {
// The data store is being deleted.
Status *string `locationName:"status" type:"string" enum:"DatastoreStatus"`
- // 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.
Storage *DatastoreStorage `locationName:"storage" type:"structure"`
}
@@ -6111,14 +6106,86 @@ func (s *DatastoreActivity) SetName(v string) *DatastoreActivity {
return s
}
-// A single partition in a data store.
+// 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.
+type DatastoreIotSiteWiseMultiLayerStorage struct {
+ _ struct{} `type:"structure"`
+
+ // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
+ //
+ // CustomerManagedS3Storage is a required field
+ CustomerManagedS3Storage *IotSiteWiseCustomerManagedDatastoreS3Storage `locationName:"customerManagedS3Storage" type:"structure" required:"true"`
+}
+
+// String returns the string representation
+func (s DatastoreIotSiteWiseMultiLayerStorage) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DatastoreIotSiteWiseMultiLayerStorage) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DatastoreIotSiteWiseMultiLayerStorage) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DatastoreIotSiteWiseMultiLayerStorage"}
+ if s.CustomerManagedS3Storage == nil {
+ invalidParams.Add(request.NewErrParamRequired("CustomerManagedS3Storage"))
+ }
+ if s.CustomerManagedS3Storage != nil {
+ if err := s.CustomerManagedS3Storage.Validate(); err != nil {
+ invalidParams.AddNested("CustomerManagedS3Storage", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCustomerManagedS3Storage sets the CustomerManagedS3Storage field's value.
+func (s *DatastoreIotSiteWiseMultiLayerStorage) SetCustomerManagedS3Storage(v *IotSiteWiseCustomerManagedDatastoreS3Storage) *DatastoreIotSiteWiseMultiLayerStorage {
+ s.CustomerManagedS3Storage = v
+ return s
+}
+
+// Contains information about the data store that you manage, which stores data
+// used by IoT SiteWise.
+type DatastoreIotSiteWiseMultiLayerStorageSummary struct {
+ _ struct{} `type:"structure"`
+
+ // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
+ CustomerManagedS3Storage *IotSiteWiseCustomerManagedDatastoreS3StorageSummary `locationName:"customerManagedS3Storage" type:"structure"`
+}
+
+// String returns the string representation
+func (s DatastoreIotSiteWiseMultiLayerStorageSummary) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DatastoreIotSiteWiseMultiLayerStorageSummary) GoString() string {
+ return s.String()
+}
+
+// SetCustomerManagedS3Storage sets the CustomerManagedS3Storage field's value.
+func (s *DatastoreIotSiteWiseMultiLayerStorageSummary) SetCustomerManagedS3Storage(v *IotSiteWiseCustomerManagedDatastoreS3StorageSummary) *DatastoreIotSiteWiseMultiLayerStorageSummary {
+ s.CustomerManagedS3Storage = v
+ return s
+}
+
+// A single dimension to partition a data store. The dimension must be an AttributePartition
+// or a TimestampPartition.
type DatastorePartition struct {
_ struct{} `type:"structure"`
- // A partition defined by an attributeName.
+ // A partition dimension defined by an attributeName.
AttributePartition *Partition `locationName:"attributePartition" type:"structure"`
- // A partition defined by an attributeName and a timestamp format.
+ // A partition dimension defined by a timestamp attribute.
TimestampPartition *TimestampPartition `locationName:"timestampPartition" type:"structure"`
}
@@ -6164,11 +6231,11 @@ func (s *DatastorePartition) SetTimestampPartition(v *TimestampPartition) *Datas
return s
}
-// Contains information about partitions in a data store.
+// Contains information about the partition dimensions in a data store.
type DatastorePartitions struct {
_ struct{} `type:"structure"`
- // A list of partitions in a data store.
+ // A list of partition dimensions in a data store.
Partitions []*DatastorePartition `locationName:"partitions" type:"list"`
}
@@ -6232,21 +6299,25 @@ func (s *DatastoreStatistics) SetSize(v *EstimatedResourceSize) *DatastoreStatis
return s
}
-// 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.
type DatastoreStorage struct {
_ struct{} `type:"structure"`
- // 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.
CustomerManagedS3 *CustomerManagedDatastoreS3Storage `locationName:"customerManagedS3" type:"structure"`
- // 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.
+ // 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.
+ IotSiteWiseMultiLayerStorage *DatastoreIotSiteWiseMultiLayerStorage `locationName:"iotSiteWiseMultiLayerStorage" type:"structure"`
+
+ // 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.
ServiceManagedS3 *ServiceManagedDatastoreS3Storage `locationName:"serviceManagedS3" type:"structure"`
}
@@ -6268,6 +6339,11 @@ func (s *DatastoreStorage) Validate() error {
invalidParams.AddNested("CustomerManagedS3", err.(request.ErrInvalidParams))
}
}
+ if s.IotSiteWiseMultiLayerStorage != nil {
+ if err := s.IotSiteWiseMultiLayerStorage.Validate(); err != nil {
+ invalidParams.AddNested("IotSiteWiseMultiLayerStorage", err.(request.ErrInvalidParams))
+ }
+ }
if invalidParams.Len() > 0 {
return invalidParams
@@ -6281,20 +6357,29 @@ func (s *DatastoreStorage) SetCustomerManagedS3(v *CustomerManagedDatastoreS3Sto
return s
}
+// SetIotSiteWiseMultiLayerStorage sets the IotSiteWiseMultiLayerStorage field's value.
+func (s *DatastoreStorage) SetIotSiteWiseMultiLayerStorage(v *DatastoreIotSiteWiseMultiLayerStorage) *DatastoreStorage {
+ s.IotSiteWiseMultiLayerStorage = v
+ return s
+}
+
// SetServiceManagedS3 sets the ServiceManagedS3 field's value.
func (s *DatastoreStorage) SetServiceManagedS3(v *ServiceManagedDatastoreS3Storage) *DatastoreStorage {
s.ServiceManagedS3 = v
return s
}
-// Where data store data is stored.
+// Contains information about your data store.
type DatastoreStorageSummary struct {
_ struct{} `type:"structure"`
- // Used to store data store data in an S3 bucket that you manage.
+ // Used to store data in an Amazon S3 bucket managed by IoT Analytics.
CustomerManagedS3 *CustomerManagedDatastoreS3StorageSummary `locationName:"customerManagedS3" type:"structure"`
- // Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
+ // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.
+ IotSiteWiseMultiLayerStorage *DatastoreIotSiteWiseMultiLayerStorageSummary `locationName:"iotSiteWiseMultiLayerStorage" type:"structure"`
+
+ // Used to store data in an Amazon S3 bucket managed by IoT Analytics.
ServiceManagedS3 *ServiceManagedDatastoreS3StorageSummary `locationName:"serviceManagedS3" type:"structure"`
}
@@ -6314,6 +6399,12 @@ func (s *DatastoreStorageSummary) SetCustomerManagedS3(v *CustomerManagedDatasto
return s
}
+// SetIotSiteWiseMultiLayerStorage sets the IotSiteWiseMultiLayerStorage field's value.
+func (s *DatastoreStorageSummary) SetIotSiteWiseMultiLayerStorage(v *DatastoreIotSiteWiseMultiLayerStorageSummary) *DatastoreStorageSummary {
+ s.IotSiteWiseMultiLayerStorage = v
+ return s
+}
+
// SetServiceManagedS3 sets the ServiceManagedS3 field's value.
func (s *DatastoreStorageSummary) SetServiceManagedS3(v *ServiceManagedDatastoreS3StorageSummary) *DatastoreStorageSummary {
s.ServiceManagedS3 = v
@@ -6330,10 +6421,10 @@ type DatastoreSummary struct {
// The name of the data store.
DatastoreName *string `locationName:"datastoreName" min:"1" type:"string"`
- // Contains information about the partitions in a data store.
+ // Contains information about the partition dimensions in a data store.
DatastorePartitions *DatastorePartitions `locationName:"datastorePartitions" type:"structure"`
- // Where data store data is stored.
+ // Where data in a data store is stored.
DatastoreStorage *DatastoreStorageSummary `locationName:"datastoreStorage" type:"structure"`
// The file format of the data in the data store.
@@ -6341,8 +6432,9 @@ type DatastoreSummary struct {
// 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.
+ // 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.
@@ -6540,7 +6632,7 @@ func (s DeleteDatasetContentOutput) GoString() string {
type DeleteDatasetInput struct {
_ struct{} `type:"structure"`
- // The name of the data set to delete.
+ // The name of the dataset to delete.
//
// DatasetName is a required field
DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
@@ -6773,14 +6865,14 @@ func (s *DeltaTime) SetTimeExpression(v string) *DeltaTime {
// 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) (https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6)
-// in the AWS IoT Analytics User Guide.
+// in the IoT Analytics User Guide.
type DeltaTimeSessionWindowConfiguration struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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 (https://prestodb.io/docs/0.172/functions/datetime.html),
@@ -6831,7 +6923,7 @@ type DescribeChannelInput struct {
ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`
// If true, additional statistical information about the channel is included
- // in the response. This feature cannot be used with a channel whose S3 storage
+ // in the response. This feature can't be used with a channel whose S3 storage
// is customer-managed.
IncludeStatistics *bool `location:"querystring" locationName:"includeStatistics" type:"boolean"`
}
@@ -6910,7 +7002,7 @@ func (s *DescribeChannelOutput) SetStatistics(v *ChannelStatistics) *DescribeCha
type DescribeDatasetInput struct {
_ struct{} `type:"structure"`
- // The name of the data set whose information is retrieved.
+ // The name of the dataset whose information is retrieved.
//
// DatasetName is a required field
DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
@@ -6951,7 +7043,7 @@ func (s *DescribeDatasetInput) SetDatasetName(v string) *DescribeDatasetInput {
type DescribeDatasetOutput struct {
_ struct{} `type:"structure"`
- // An object that contains information about the data set.
+ // An object that contains information about the dataset.
Dataset *Dataset `locationName:"dataset" type:"structure"`
}
@@ -6980,7 +7072,7 @@ type DescribeDatastoreInput struct {
DatastoreName *string `location:"uri" locationName:"datastoreName" min:"1" type:"string" required:"true"`
// 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
+ // in the response. This feature can't be used with a data store whose S3 storage
// is customer-managed.
IncludeStatistics *bool `location:"querystring" locationName:"includeStatistics" type:"boolean"`
}
@@ -7073,7 +7165,7 @@ func (s DescribeLoggingOptionsInput) GoString() string {
type DescribeLoggingOptionsOutput struct {
_ struct{} `type:"structure"`
- // The current settings of the AWS IoT Analytics logging options.
+ // The current settings of the IoT Analytics logging options.
LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure"`
}
@@ -7157,7 +7249,7 @@ func (s *DescribePipelineOutput) SetPipeline(v *Pipeline) *DescribePipelineOutpu
return s
}
-// An activity that adds data from the AWS IoT device registry to your message.
+// An activity that adds data from the IoT device registry to your message.
type DeviceRegistryEnrichActivity struct {
_ struct{} `type:"structure"`
@@ -7262,8 +7354,8 @@ func (s *DeviceRegistryEnrichActivity) SetThingName(v string) *DeviceRegistryEnr
return s
}
-// An activity that adds information from the AWS IoT Device Shadow service
-// to a message.
+// An activity that adds information from the IoT Device Shadow service to a
+// message.
type DeviceShadowEnrichActivity struct {
_ struct{} `type:"structure"`
@@ -7401,8 +7493,8 @@ func (s *EstimatedResourceSize) SetEstimatedSizeInBytes(v float64) *EstimatedRes
return s
}
-// Contains the configuration information of file formats. AWS IoT Analytics
-// data stores support JSON and Parquet (https://parquet.apache.org/).
+// Contains the configuration information of file formats. IoT Analytics data
+// stores support JSON and Parquet (https://parquet.apache.org/).
//
// The default file format is JSON. You can specify only one format.
//
@@ -7529,14 +7621,14 @@ func (s *FilterActivity) SetNext(v string) *FilterActivity {
type GetDatasetContentInput struct {
_ struct{} `type:"structure"`
- // The name of the data set whose contents are retrieved.
+ // The name of the dataset whose contents are retrieved.
//
// DatasetName is a required field
DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
- // The version of the data set whose contents are retrieved. You can also use
+ // 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 data set. If not specified, "$LATEST_SUCCEEDED"
+ // the latest or latest successfully completed dataset. If not specified, "$LATEST_SUCCEEDED"
// is the default.
VersionId *string `location:"querystring" locationName:"versionId" min:"7" type:"string"`
}
@@ -7588,7 +7680,7 @@ type GetDatasetContentOutput struct {
// A list of DatasetEntry objects.
Entries []*DatasetEntry `locationName:"entries" type:"list"`
- // The status of the data set content.
+ // The status of the dataset content.
Status *DatasetContentStatus `locationName:"status" type:"structure"`
// The time when the request was made.
@@ -7623,20 +7715,20 @@ func (s *GetDatasetContentOutput) SetTimestamp(v time.Time) *GetDatasetContentOu
return s
}
-// Configuration information for coordination with AWS Glue, a fully managed
-// extract, transform and load (ETL) service.
+// Configuration information for coordination with Glue, a fully managed extract,
+// transform and load (ETL) service.
type GlueConfiguration struct {
_ struct{} `type:"structure"`
- // 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.
+ // The name of the database in your Glue Data Catalog in which the table is
+ // located. An Glue Data Catalog database contains metadata tables.
//
// DatabaseName is a required field
DatabaseName *string `locationName:"databaseName" min:"1" type:"string" required:"true"`
- // 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.
+ // 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.
//
// TableName is a required field
TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
@@ -7798,17 +7890,17 @@ func (s *InvalidRequestException) RequestID() string {
return s.RespMetadata.RequestID
}
-// Configuration information for delivery of dataset contents to AWS IoT Events.
+// Configuration information for delivery of dataset contents to IoT Events.
type IotEventsDestinationConfiguration struct {
_ struct{} `type:"structure"`
- // The name of the AWS IoT Events input to which dataset contents are delivered.
+ // The name of the IoT Events input to which dataset contents are delivered.
//
// InputName is a required field
InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`
- // The ARN of the role that grants AWS IoT Analytics permission to deliver dataset
- // contents to an AWS IoT Events input.
+ // The ARN of the role that grants IoT Analytics permission to deliver dataset
+ // contents to an IoT Events input.
//
// RoleArn is a required field
RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
@@ -7858,6 +7950,102 @@ func (s *IotEventsDestinationConfiguration) SetRoleArn(v string) *IotEventsDesti
return s
}
+// 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.
+type IotSiteWiseCustomerManagedDatastoreS3Storage struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the Amazon S3 bucket where your data is stored.
+ //
+ // Bucket is a required field
+ Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`
+
+ // (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 (/).
+ KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
+}
+
+// String returns the string representation
+func (s IotSiteWiseCustomerManagedDatastoreS3Storage) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s IotSiteWiseCustomerManagedDatastoreS3Storage) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *IotSiteWiseCustomerManagedDatastoreS3Storage) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "IotSiteWiseCustomerManagedDatastoreS3Storage"}
+ if s.Bucket == nil {
+ invalidParams.Add(request.NewErrParamRequired("Bucket"))
+ }
+ if s.Bucket != nil && len(*s.Bucket) < 3 {
+ invalidParams.Add(request.NewErrParamMinLen("Bucket", 3))
+ }
+ if s.KeyPrefix != nil && len(*s.KeyPrefix) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("KeyPrefix", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetBucket sets the Bucket field's value.
+func (s *IotSiteWiseCustomerManagedDatastoreS3Storage) SetBucket(v string) *IotSiteWiseCustomerManagedDatastoreS3Storage {
+ s.Bucket = &v
+ return s
+}
+
+// SetKeyPrefix sets the KeyPrefix field's value.
+func (s *IotSiteWiseCustomerManagedDatastoreS3Storage) SetKeyPrefix(v string) *IotSiteWiseCustomerManagedDatastoreS3Storage {
+ s.KeyPrefix = &v
+ return s
+}
+
+// Contains information about the data store that you manage, which stores data
+// used by IoT SiteWise.
+type IotSiteWiseCustomerManagedDatastoreS3StorageSummary struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the Amazon S3 bucket where your data is stored.
+ Bucket *string `locationName:"bucket" min:"3" type:"string"`
+
+ // (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 (/).
+ KeyPrefix *string `locationName:"keyPrefix" min:"1" type:"string"`
+}
+
+// String returns the string representation
+func (s IotSiteWiseCustomerManagedDatastoreS3StorageSummary) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s IotSiteWiseCustomerManagedDatastoreS3StorageSummary) GoString() string {
+ return s.String()
+}
+
+// SetBucket sets the Bucket field's value.
+func (s *IotSiteWiseCustomerManagedDatastoreS3StorageSummary) SetBucket(v string) *IotSiteWiseCustomerManagedDatastoreS3StorageSummary {
+ s.Bucket = &v
+ return s
+}
+
+// SetKeyPrefix sets the KeyPrefix field's value.
+func (s *IotSiteWiseCustomerManagedDatastoreS3StorageSummary) SetKeyPrefix(v string) *IotSiteWiseCustomerManagedDatastoreS3StorageSummary {
+ s.KeyPrefix = &v
+ return s
+}
+
// Contains the configuration information of the JSON format.
type JsonConfiguration struct {
_ struct{} `type:"structure"`
@@ -8199,7 +8387,7 @@ func (s *ListChannelsOutput) SetNextToken(v string) *ListChannelsOutput {
type ListDatasetContentsInput struct {
_ struct{} `type:"structure"`
- // The name of the data set whose contents information you want to list.
+ // The name of the dataset whose contents information you want to list.
//
// DatasetName is a required field
DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
@@ -8210,12 +8398,12 @@ type ListDatasetContentsInput struct {
// The token for the next set of results.
NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
- // A filter to limit results to those data set contents whose creation is scheduled
+ // 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)
ScheduledBefore *time.Time `location:"querystring" locationName:"scheduledBefore" type:"timestamp"`
- // A filter to limit results to those data set contents whose creation is scheduled
+ // 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)
ScheduledOnOrAfter *time.Time `location:"querystring" locationName:"scheduledOnOrAfter" type:"timestamp"`
@@ -8283,7 +8471,7 @@ func (s *ListDatasetContentsInput) SetScheduledOnOrAfter(v time.Time) *ListDatas
type ListDatasetContentsOutput struct {
_ struct{} `type:"structure"`
- // Summary information about data set contents that have been created.
+ // Summary information about dataset contents that have been created.
DatasetContentSummaries []*DatasetContentSummary `locationName:"datasetContentSummaries" type:"list"`
// The token to retrieve the next set of results, or null if there are no more
@@ -8621,7 +8809,7 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
type LoggingOptions struct {
_ struct{} `type:"structure"`
- // If true, logging is enabled for AWS IoT Analytics.
+ // If true, logging is enabled for IoT Analytics.
//
// Enabled is a required field
Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`
@@ -8631,8 +8819,7 @@ type LoggingOptions struct {
// Level is a required field
Level *string `locationName:"level" type:"string" required:"true" enum:"LoggingLevel"`
- // The ARN of the role that grants permission to AWS IoT Analytics to perform
- // logging.
+ // The ARN of the role that grants permission to IoT Analytics to perform logging.
//
// RoleArn is a required field
RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
@@ -8917,11 +9104,11 @@ func (s *ParquetConfiguration) SetSchemaDefinition(v *SchemaDefinition) *Parquet
return s
}
-// A single partition.
+// A partition dimension defined by an attribute.
type Partition struct {
_ struct{} `type:"structure"`
- // The attribute name of the partition.
+ // The name of the attribute that defines a partition dimension.
//
// AttributeName is a required field
AttributeName *string `locationName:"attributeName" min:"1" type:"string" required:"true"`
@@ -9041,10 +9228,10 @@ type PipelineActivity struct {
// Specifies where to store the processed message data.
Datastore *DatastoreActivity `locationName:"datastore" type:"structure"`
- // Adds data from the AWS IoT device registry to your message.
+ // Adds data from the IoT device registry to your message.
DeviceRegistryEnrich *DeviceRegistryEnrichActivity `locationName:"deviceRegistryEnrich" type:"structure"`
- // Adds information from the AWS IoT Device Shadow service to a message.
+ // Adds information from the IoT Device Shadow service to a message.
DeviceShadowEnrich *DeviceShadowEnrichActivity `locationName:"deviceShadowEnrich" type:"structure"`
// Filters a message based on its attributes.
@@ -9060,8 +9247,8 @@ type PipelineActivity struct {
// Removes attributes from a message.
RemoveAttributes *RemoveAttributesActivity `locationName:"removeAttributes" type:"structure"`
- // Creates a new message using only the specified attributes from the original
- // message.
+ // Used to create a new message using only the specified attributes from the
+ // original message.
SelectAttributes *SelectAttributesActivity `locationName:"selectAttributes" type:"structure"`
}
@@ -9249,7 +9436,7 @@ func (s *PipelineSummary) SetReprocessingSummaries(v []*ReprocessingSummary) *Pi
type PutLoggingOptionsInput struct {
_ struct{} `type:"structure"`
- // The new values of the AWS IoT Analytics logging options.
+ // The new values of the IoT Analytics logging options.
//
// LoggingOptions is a required field
LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
@@ -9689,9 +9876,9 @@ type RunPipelineActivityInput struct {
Payloads [][]byte `locationName:"payloads" min:"1" type:"list" required:"true"`
// 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
+ // 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
+ // 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.
//
// PipelineActivity is a required field
@@ -9788,8 +9975,8 @@ type S3DestinationConfiguration struct {
// Bucket is a required field
Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`
- // Configuration information for coordination with AWS Glue, a fully managed
- // extract, transform and load (ETL) service.
+ // Configuration information for coordination with Glue, a fully managed extract,
+ // transform and load (ETL) service.
GlueConfiguration *GlueConfiguration `locationName:"glueConfiguration" type:"structure"`
// The key of the dataset contents object in an S3 bucket. Each object has a
@@ -9816,8 +10003,8 @@ type S3DestinationConfiguration struct {
// Key is a required field
Key *string `locationName:"key" min:"1" type:"string" required:"true"`
- // The ARN of the role that grants AWS IoT Analytics permission to interact
- // with your Amazon S3 and AWS Glue resources.
+ // The ARN of the role that grants IoT Analytics permission to interact with
+ // your Amazon S3 and Glue resources.
//
// RoleArn is a required field
RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
@@ -10059,8 +10246,8 @@ func (s *SchemaDefinition) SetColumns(v []*Column) *SchemaDefinition {
return s
}
-// Creates a new message using only the specified attributes from the original
-// message.
+// Used to create a new message using only the specified attributes from the
+// original message.
type SelectAttributesActivity struct {
_ struct{} `type:"structure"`
@@ -10131,9 +10318,8 @@ func (s *SelectAttributesActivity) SetNext(v string) *SelectAttributesActivity {
return s
}
-// 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.
+// 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.
type ServiceManagedChannelS3Storage struct {
_ struct{} `type:"structure"`
}
@@ -10148,7 +10334,7 @@ func (s ServiceManagedChannelS3Storage) GoString() string {
return s.String()
}
-// Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
+// Used to store channel data in an S3 bucket managed by IoT Analytics.
type ServiceManagedChannelS3StorageSummary struct {
_ struct{} `type:"structure"`
}
@@ -10163,9 +10349,8 @@ func (s ServiceManagedChannelS3StorageSummary) GoString() string {
return s.String()
}
-// 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.
+// 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.
type ServiceManagedDatastoreS3Storage struct {
_ struct{} `type:"structure"`
}
@@ -10180,7 +10365,7 @@ func (s ServiceManagedDatastoreS3Storage) GoString() string {
return s.String()
}
-// Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
+// Contains information about the data store that is managed by IoT Analytics.
type ServiceManagedDatastoreS3StorageSummary struct {
_ struct{} `type:"structure"`
}
@@ -10611,7 +10796,7 @@ func (s *ThrottlingException) RequestID() string {
return s.RespMetadata.RequestID
}
-// A partition defined by a timestamp.
+// A partition dimension defined by a timestamp attribute.
type TimestampPartition struct {
_ struct{} `type:"structure"`
@@ -10620,7 +10805,8 @@ type TimestampPartition struct {
// AttributeName is a required field
AttributeName *string `locationName:"attributeName" min:"1" type:"string" required:"true"`
- // The timestamp format of a partition defined by a timestamp.
+ // The timestamp format of a partition defined by a timestamp. The default format
+ // is seconds since epoch (January 1, 1970 at midnight UTC time).
TimestampFormat *string `locationName:"timestampFormat" min:"1" type:"string"`
}
@@ -10790,12 +10976,12 @@ type UpdateChannelInput struct {
ChannelName *string `location:"uri" locationName:"channelName" min:"1" type:"string" required:"true"`
// Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3
- // storage. If not specified, the default is serviceManagedS3. You cannot change
+ // storage. If not specified, the default is serviceManagedS3. You can't change
// this storage option after the channel is created.
ChannelStorage *ChannelStorage `locationName:"channelStorage" type:"structure"`
// 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.
+ // can't be updated if the channel's Amazon S3 storage is customer-managed.
RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
}
@@ -10879,14 +11065,13 @@ type UpdateDatasetInput struct {
// here.
ContentDeliveryRules []*DatasetContentDeliveryRule `locationName:"contentDeliveryRules" type:"list"`
- // The name of the data set to update.
+ // The name of the dataset to update.
//
// DatasetName is a required field
DatasetName *string `location:"uri" locationName:"datasetName" min:"1" type:"string" required:"true"`
- // A list of data rules that send notifications to Amazon CloudWatch, when data
- // arrives late. To specify lateDataRules, the dataset must use a DeltaTimer
- // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
+ // A list of data rules that send notifications to CloudWatch, when data arrives
+ // late. To specify lateDataRules, the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html)
// filter.
LateDataRules []*LateDataRule `locationName:"lateDataRules" min:"1" type:"list"`
@@ -10900,9 +11085,9 @@ type UpdateDatasetInput struct {
// 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 (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
- // in the AWS IoT Analytics User Guide.
+ // parameter. For more information, see Keeping Multiple Versions of IoT Analytics
+ // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
+ // in the IoT Analytics User Guide.
VersioningConfiguration *VersioningConfiguration `locationName:"versioningConfiguration" type:"structure"`
}
@@ -11055,13 +11240,14 @@ type UpdateDatastoreInput struct {
// DatastoreName is a required field
DatastoreName *string `location:"uri" locationName:"datastoreName" min:"1" type:"string" required:"true"`
- // 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.
DatastoreStorage *DatastoreStorage `locationName:"datastoreStorage" type:"structure"`
- // Contains the configuration information of file formats. AWS IoT Analytics
- // data stores support JSON and Parquet (https://parquet.apache.org/).
+ // Contains the configuration information of file formats. IoT Analytics data
+ // stores support JSON and Parquet (https://parquet.apache.org/).
//
// The default file format is JSON. You can specify only one format.
//
@@ -11069,7 +11255,7 @@ type UpdateDatastoreInput struct {
FileFormatConfiguration *FileFormatConfiguration `locationName:"fileFormatConfiguration" type:"structure"`
// 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.
+ // period can't be updated if the data store's Amazon S3 storage is customer-managed.
RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`
}
diff --git a/service/iotanalytics/doc.go b/service/iotanalytics/doc.go
index 9ea1c7e8c9..f2f68f2e26 100644
--- a/service/iotanalytics/doc.go
+++ b/service/iotanalytics/doc.go
@@ -3,9 +3,9 @@
// Package iotanalytics provides the client and types for making API
// requests to AWS IoT Analytics.
//
-// AWS IoT Analytics allows you to collect large amounts of device data, process
+// 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
+// analytics on it. IoT Analytics enables advanced data exploration through
// integration with Jupyter Notebooks and data visualization through integration
// with Amazon QuickSight.
//
@@ -16,14 +16,14 @@
// 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
+// 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. AWS IoT Analytics includes
+// 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.
diff --git a/service/iotwireless/api.go b/service/iotwireless/api.go
index e797451a9e..e087b22d7d 100644
--- a/service/iotwireless/api.go
+++ b/service/iotwireless/api.go
@@ -2292,8 +2292,9 @@ func (c *IoTWireless) GetLogLevelsByResourceTypesRequest(input *GetLogLevelsByRe
// GetLogLevelsByResourceTypes API operation for AWS IoT Wireless.
//
-// Returns current default log-levels, or log levels by resource types, could
-// be for wireless device log options or wireless gateway log options.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2473,8 +2474,8 @@ func (c *IoTWireless) GetResourceLogLevelRequest(input *GetResourceLogLevelInput
// GetResourceLogLevel API operation for AWS IoT Wireless.
//
-// Fetches the log-level override if any for a given resource-ID and resource-type,
-// coulde be a wireless device or a wireless gateway.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4472,8 +4473,9 @@ func (c *IoTWireless) PutResourceLogLevelRequest(input *PutResourceLogLevelInput
// PutResourceLogLevel API operation for AWS IoT Wireless.
//
-// Sets the log-level override for a resource-ID and resource-type, could be
-// a wireless gateway or a wireless device.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4565,8 +4567,8 @@ func (c *IoTWireless) ResetAllResourceLogLevelsRequest(input *ResetAllResourceLo
// ResetAllResourceLogLevels API operation for AWS IoT Wireless.
//
-// Remove log-level overrides if any for all resources (both wireless devices
-// and wireless gateways).
+// Removes the log-level overrides for all resources; both wireless devices
+// and wireless gateways.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4658,8 +4660,8 @@ func (c *IoTWireless) ResetResourceLogLevelRequest(input *ResetResourceLogLevelI
// ResetResourceLogLevel API operation for AWS IoT Wireless.
//
-// Remove log-level override if any for a specific resource-ID and resource-type,
-// could be a wireless device or a wireless gateway.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5206,9 +5208,9 @@ func (c *IoTWireless) UpdateLogLevelsByResourceTypesRequest(input *UpdateLogLeve
// UpdateLogLevelsByResourceTypes API operation for AWS IoT Wireless.
//
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -8028,12 +8030,12 @@ type GetResourceLogLevelInput struct {
_ struct{} `type:"structure"`
// 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.
+ // device ID. For a wireless gateway, it is the wireless gateway ID.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"ResourceIdentifier" type:"string" required:"true"`
- // The type of the resource, currently support WirelessDevice and WirelessGateway.
+ // The type of the resource, which can be WirelessDevice or WirelessGateway.
//
// ResourceType is a required field
ResourceType *string `location:"querystring" locationName:"resourceType" type:"string" required:"true"`
@@ -10726,12 +10728,12 @@ type PutResourceLogLevelInput struct {
LogLevel *string `type:"string" required:"true" enum:"LogLevel"`
// 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.
+ // device ID. For a wireless gateway, it is the wireless gateway ID.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"ResourceIdentifier" type:"string" required:"true"`
- // The type of the resource, currently support WirelessDevice and WirelessGateway.
+ // The type of the resource, which can be WirelessDevice or WirelessGateway.
//
// ResourceType is a required field
ResourceType *string `location:"querystring" locationName:"resourceType" type:"string" required:"true"`
@@ -10833,12 +10835,12 @@ type ResetResourceLogLevelInput struct {
_ struct{} `type:"structure"`
// 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.
+ // device ID. For a wireless gateway, it is the wireless gateway ID.
//
// ResourceIdentifier is a required field
ResourceIdentifier *string `location:"uri" locationName:"ResourceIdentifier" type:"string" required:"true"`
- // The type of the resource, currently support WirelessDevice and WirelessGateway.
+ // The type of the resource, which can be WirelessDevice or WirelessGateway.
//
// ResourceType is a required field
ResourceType *string `location:"querystring" locationName:"resourceType" type:"string" required:"true"`
@@ -10969,7 +10971,7 @@ type SendDataToWirelessDeviceInput struct {
// Id is a required field
Id *string `location:"uri" locationName:"Id" type:"string" required:"true"`
- // The message payload to send.
+ // The binary to be sent to the end device, encoded in base64.
//
// PayloadData is a required field
PayloadData *string `type:"string" required:"true"`
@@ -11286,6 +11288,9 @@ func (s *SidewalkAccountInfoWithFingerprint) SetFingerprint(v string) *SidewalkA
type SidewalkDevice struct {
_ struct{} `type:"structure"`
+ // The Sidewalk Amazon ID.
+ AmazonId *string `type:"string"`
+
// The sidewalk device certificates for Ed25519 and P256r1.
DeviceCertificates []*CertificateList `type:"list"`
@@ -11306,6 +11311,12 @@ func (s SidewalkDevice) GoString() string {
return s.String()
}
+// SetAmazonId sets the AmazonId field's value.
+func (s *SidewalkDevice) SetAmazonId(v string) *SidewalkDevice {
+ s.AmazonId = &v
+ return s
+}
+
// SetDeviceCertificates sets the DeviceCertificates field's value.
func (s *SidewalkDevice) SetDeviceCertificates(v []*CertificateList) *SidewalkDevice {
s.DeviceCertificates = v
@@ -11430,7 +11441,7 @@ func (s *SidewalkListDevice) SetSidewalkManufacturingSn(v string) *SidewalkListD
type SidewalkSendDataToDevice struct {
_ struct{} `type:"structure"`
- // Sidewalk device message type.
+ // Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.
MessageType *string `type:"string" enum:"MessageType"`
// The sequence number.
@@ -12491,11 +12502,12 @@ func (s *ValidationException) RequestID() string {
return s.RespMetadata.RequestID
}
-// 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.
+// 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.
type WirelessDeviceEventLogOption struct {
_ struct{} `type:"structure"`
@@ -12548,8 +12560,8 @@ func (s *WirelessDeviceEventLogOption) SetLogLevel(v string) *WirelessDeviceEven
return s
}
-// The log option for wireless devices. Can be used to set log level for a specific
-// type of wireless device.
+// The log options for wireless devices and can be used to set log levels for
+// a specific type of wireless device.
type WirelessDeviceLogOption struct {
_ struct{} `type:"structure"`
@@ -12708,9 +12720,11 @@ func (s *WirelessDeviceStatistics) SetType(v string) *WirelessDeviceStatistics {
return s
}
-// 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.
+// 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.
type WirelessGatewayEventLogOption struct {
_ struct{} `type:"structure"`
@@ -12763,8 +12777,8 @@ func (s *WirelessGatewayEventLogOption) SetLogLevel(v string) *WirelessGatewayEv
return s
}
-// The log option for wireless gateways. Can be used to set log level for a
-// specific type of wireless gateway.
+// The log options for wireless gateways and can be used to set log levels for
+// a specific type of wireless gateway.
type WirelessGatewayLogOption struct {
_ struct{} `type:"structure"`
@@ -13081,7 +13095,7 @@ func LogLevel_Values() []string {
}
}
-// Sidewalk device message type.
+// Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.
const (
// MessageTypeCustomCommandIdNotify is a MessageType enum value
MessageTypeCustomCommandIdNotify = "CUSTOM_COMMAND_ID_NOTIFY"
@@ -13173,6 +13187,9 @@ const (
// WirelessDeviceIdTypeThingName is a WirelessDeviceIdType enum value
WirelessDeviceIdTypeThingName = "ThingName"
+
+ // WirelessDeviceIdTypeSidewalkManufacturingSn is a WirelessDeviceIdType enum value
+ WirelessDeviceIdTypeSidewalkManufacturingSn = "SidewalkManufacturingSn"
)
// WirelessDeviceIdType_Values returns all elements of the WirelessDeviceIdType enum
@@ -13181,6 +13198,7 @@ func WirelessDeviceIdType_Values() []string {
WirelessDeviceIdTypeWirelessDeviceId,
WirelessDeviceIdTypeDevEui,
WirelessDeviceIdTypeThingName,
+ WirelessDeviceIdTypeSidewalkManufacturingSn,
}
}
diff --git a/service/lexmodelsv2/lexmodelsv2iface/interface.go b/service/lexmodelsv2/lexmodelsv2iface/interface.go
index 297485b96d..5a4224cbb7 100644
--- a/service/lexmodelsv2/lexmodelsv2iface/interface.go
+++ b/service/lexmodelsv2/lexmodelsv2iface/interface.go
@@ -316,6 +316,30 @@ type LexModelsV2API interface {
UpdateSlotType(*lexmodelsv2.UpdateSlotTypeInput) (*lexmodelsv2.UpdateSlotTypeOutput, error)
UpdateSlotTypeWithContext(aws.Context, *lexmodelsv2.UpdateSlotTypeInput, ...request.Option) (*lexmodelsv2.UpdateSlotTypeOutput, error)
UpdateSlotTypeRequest(*lexmodelsv2.UpdateSlotTypeInput) (*request.Request, *lexmodelsv2.UpdateSlotTypeOutput)
+
+ WaitUntilBotAliasAvailable(*lexmodelsv2.DescribeBotAliasInput) error
+ WaitUntilBotAliasAvailableWithContext(aws.Context, *lexmodelsv2.DescribeBotAliasInput, ...request.WaiterOption) error
+
+ WaitUntilBotAvailable(*lexmodelsv2.DescribeBotInput) error
+ WaitUntilBotAvailableWithContext(aws.Context, *lexmodelsv2.DescribeBotInput, ...request.WaiterOption) error
+
+ WaitUntilBotExportCompleted(*lexmodelsv2.DescribeExportInput) error
+ WaitUntilBotExportCompletedWithContext(aws.Context, *lexmodelsv2.DescribeExportInput, ...request.WaiterOption) error
+
+ WaitUntilBotImportCompleted(*lexmodelsv2.DescribeImportInput) error
+ WaitUntilBotImportCompletedWithContext(aws.Context, *lexmodelsv2.DescribeImportInput, ...request.WaiterOption) error
+
+ WaitUntilBotLocaleBuilt(*lexmodelsv2.DescribeBotLocaleInput) error
+ WaitUntilBotLocaleBuiltWithContext(aws.Context, *lexmodelsv2.DescribeBotLocaleInput, ...request.WaiterOption) error
+
+ WaitUntilBotLocaleCreated(*lexmodelsv2.DescribeBotLocaleInput) error
+ WaitUntilBotLocaleCreatedWithContext(aws.Context, *lexmodelsv2.DescribeBotLocaleInput, ...request.WaiterOption) error
+
+ WaitUntilBotLocaleExpressTestingAvailable(*lexmodelsv2.DescribeBotLocaleInput) error
+ WaitUntilBotLocaleExpressTestingAvailableWithContext(aws.Context, *lexmodelsv2.DescribeBotLocaleInput, ...request.WaiterOption) error
+
+ WaitUntilBotVersionAvailable(*lexmodelsv2.DescribeBotVersionInput) error
+ WaitUntilBotVersionAvailableWithContext(aws.Context, *lexmodelsv2.DescribeBotVersionInput, ...request.WaiterOption) error
}
var _ LexModelsV2API = (*lexmodelsv2.LexModelsV2)(nil)
diff --git a/service/lexmodelsv2/waiters.go b/service/lexmodelsv2/waiters.go
new file mode 100644
index 0000000000..9414e7161a
--- /dev/null
+++ b/service/lexmodelsv2/waiters.go
@@ -0,0 +1,493 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package lexmodelsv2
+
+import (
+ "time"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/request"
+)
+
+// WaitUntilBotAliasAvailable uses the Lex Models V2 API operation
+// DescribeBotAlias to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotAliasAvailable(input *DescribeBotAliasInput) error {
+ return c.WaitUntilBotAliasAvailableWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotAliasAvailableWithContext is an extended version of WaitUntilBotAliasAvailable.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotAliasAvailableWithContext(ctx aws.Context, input *DescribeBotAliasInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotAliasAvailable",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botAliasStatus",
+ Expected: "Available",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botAliasStatus",
+ Expected: "Failed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botAliasStatus",
+ Expected: "Deleting",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotAliasInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotAliasRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotAvailable uses the Lex Models V2 API operation
+// DescribeBot to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotAvailable(input *DescribeBotInput) error {
+ return c.WaitUntilBotAvailableWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotAvailableWithContext is an extended version of WaitUntilBotAvailable.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotAvailableWithContext(ctx aws.Context, input *DescribeBotInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotAvailable",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Available",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Failed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Inactive",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotExportCompleted uses the Lex Models V2 API operation
+// DescribeExport to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotExportCompleted(input *DescribeExportInput) error {
+ return c.WaitUntilBotExportCompletedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotExportCompletedWithContext is an extended version of WaitUntilBotExportCompleted.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotExportCompletedWithContext(ctx aws.Context, input *DescribeExportInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotExportCompleted",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "exportStatus",
+ Expected: "Completed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "exportStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "exportStatus",
+ Expected: "Failed",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeExportInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeExportRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotImportCompleted uses the Lex Models V2 API operation
+// DescribeImport to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotImportCompleted(input *DescribeImportInput) error {
+ return c.WaitUntilBotImportCompletedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotImportCompletedWithContext is an extended version of WaitUntilBotImportCompleted.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotImportCompletedWithContext(ctx aws.Context, input *DescribeImportInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotImportCompleted",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "importStatus",
+ Expected: "Completed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "importStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "importStatus",
+ Expected: "Failed",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeImportInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeImportRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotLocaleBuilt uses the Lex Models V2 API operation
+// DescribeBotLocale to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotLocaleBuilt(input *DescribeBotLocaleInput) error {
+ return c.WaitUntilBotLocaleBuiltWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotLocaleBuiltWithContext is an extended version of WaitUntilBotLocaleBuilt.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotLocaleBuiltWithContext(ctx aws.Context, input *DescribeBotLocaleInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotLocaleBuilt",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Built",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Failed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "NotBuilt",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotLocaleInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotLocaleRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotLocaleCreated uses the Lex Models V2 API operation
+// DescribeBotLocale to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotLocaleCreated(input *DescribeBotLocaleInput) error {
+ return c.WaitUntilBotLocaleCreatedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotLocaleCreatedWithContext is an extended version of WaitUntilBotLocaleCreated.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotLocaleCreatedWithContext(ctx aws.Context, input *DescribeBotLocaleInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotLocaleCreated",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Built",
+ },
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "ReadyExpressTesting",
+ },
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "NotBuilt",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Failed",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotLocaleInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotLocaleRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotLocaleExpressTestingAvailable uses the Lex Models V2 API operation
+// DescribeBotLocale to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotLocaleExpressTestingAvailable(input *DescribeBotLocaleInput) error {
+ return c.WaitUntilBotLocaleExpressTestingAvailableWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotLocaleExpressTestingAvailableWithContext is an extended version of WaitUntilBotLocaleExpressTestingAvailable.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotLocaleExpressTestingAvailableWithContext(ctx aws.Context, input *DescribeBotLocaleInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotLocaleExpressTestingAvailable",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Built",
+ },
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "ReadyExpressTesting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "Failed",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botLocaleStatus",
+ Expected: "NotBuilt",
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotLocaleInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotLocaleRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilBotVersionAvailable uses the Lex Models V2 API operation
+// DescribeBotVersion to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *LexModelsV2) WaitUntilBotVersionAvailable(input *DescribeBotVersionInput) error {
+ return c.WaitUntilBotVersionAvailableWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilBotVersionAvailableWithContext is an extended version of WaitUntilBotVersionAvailable.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *LexModelsV2) WaitUntilBotVersionAvailableWithContext(ctx aws.Context, input *DescribeBotVersionInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilBotVersionAvailable",
+ MaxAttempts: 35,
+ Delay: request.ConstantWaiterDelay(10 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Available",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Deleting",
+ },
+ {
+ State: request.FailureWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "botStatus",
+ Expected: "Failed",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 404,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeBotVersionInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeBotVersionRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
diff --git a/service/quicksight/api.go b/service/quicksight/api.go
index 4981c7f0a6..296e95e875 100644
--- a/service/quicksight/api.go
+++ b/service/quicksight/api.go
@@ -154,17 +154,18 @@ func (c *QuickSight) CreateAccountCustomizationRequest(input *CreateAccountCusto
// CreateAccountCustomization API operation for Amazon QuickSight.
//
-// Creates Amazon QuickSight customizations the current AWS Region. Currently,
+// 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 (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html)
// 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.
+// 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
@@ -380,7 +381,7 @@ func (c *QuickSight) CreateDashboardRequest(input *CreateDashboardInput) (req *r
// 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.
+// exists in a different Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1125,9 +1126,9 @@ func (c *QuickSight) CreateIAMPolicyAssignmentRequest(input *CreateIAMPolicyAssi
//
// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1234,8 +1235,8 @@ func (c *QuickSight) CreateIngestionRequest(input *CreateIngestionInput) (req *r
// 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? (http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/)
-// in the AWS Knowledge Center. Tags are visible on the tagged dataset, but
-// not on the ingestion resource.
+// in the Amazon Web Services Knowledge Center. Tags are visible on the tagged
+// dataset, but not on the ingestion resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1343,9 +1344,10 @@ func (c *QuickSight) CreateNamespaceRequest(input *CreateNamespaceInput) (req *r
// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1455,8 +1457,8 @@ func (c *QuickSight) CreateTemplateRequest(input *CreateTemplateInput) (req *req
// CreateTemplate API operation for Amazon QuickSight.
//
-// Creates a template from an existing QuickSight analysis or template. You
-// can use the resulting template to create a dashboard.
+// 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
@@ -1891,8 +1893,8 @@ func (c *QuickSight) DeleteAccountCustomizationRequest(input *DeleteAccountCusto
// DeleteAccountCustomization API operation for Amazon QuickSight.
//
-// Deletes all Amazon QuickSight customizations in this AWS Region for the specified
-// AWS account and QuickSight namespace.
+// Deletes all Amazon QuickSight customizations in this Region; for the specified
+// Amazon Web Services account; and QuickSight namespace.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3406,8 +3408,8 @@ func (c *QuickSight) DeleteUserRequest(input *DeleteUserInput) (req *request.Req
// DeleteUser API operation for Amazon QuickSight.
//
// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3609,46 +3611,45 @@ func (c *QuickSight) DescribeAccountCustomizationRequest(input *DescribeAccountC
// DescribeAccountCustomization API operation for Amazon QuickSight.
//
-// 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.
+// 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.
//
-// * 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 (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html).
+// * 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 (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html).
// Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
-// 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 (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
+// 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 (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
//
// * 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.
+// the same Amazon Web Services account; and 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.
+// * 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3747,7 +3748,7 @@ func (c *QuickSight) DescribeAccountSettingsRequest(input *DescribeAccountSettin
// DescribeAccountSettings API operation for Amazon QuickSight.
//
// Describes the settings that were used when your QuickSight subscription was
-// first created in this AWS account.
+// first created in this Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5972,6 +5973,288 @@ func (c *QuickSight) DescribeUserWithContext(ctx aws.Context, input *DescribeUse
return out, req.Send()
}
+const opGenerateEmbedUrlForAnonymousUser = "GenerateEmbedUrlForAnonymousUser"
+
+// GenerateEmbedUrlForAnonymousUserRequest generates a "aws/request.Request" representing the
+// client's request for the GenerateEmbedUrlForAnonymousUser operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GenerateEmbedUrlForAnonymousUser for more information on using the GenerateEmbedUrlForAnonymousUser
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GenerateEmbedUrlForAnonymousUserRequest method.
+// req, resp := client.GenerateEmbedUrlForAnonymousUserRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUser
+func (c *QuickSight) GenerateEmbedUrlForAnonymousUserRequest(input *GenerateEmbedUrlForAnonymousUserInput) (req *request.Request, output *GenerateEmbedUrlForAnonymousUserOutput) {
+ op := &request.Operation{
+ Name: opGenerateEmbedUrlForAnonymousUser,
+ HTTPMethod: "POST",
+ HTTPPath: "/accounts/{AwsAccountId}/embed-url/anonymous-user",
+ }
+
+ if input == nil {
+ input = &GenerateEmbedUrlForAnonymousUserInput{}
+ }
+
+ output = &GenerateEmbedUrlForAnonymousUserOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GenerateEmbedUrlForAnonymousUser API operation for Amazon QuickSight.
+//
+// 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 (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-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 (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)
+// 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 (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Amazon QuickSight's
+// API operation GenerateEmbedUrlForAnonymousUser for usage and error information.
+//
+// Returned Error Types:
+// * AccessDeniedException
+// 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.
+//
+// * InvalidParameterValueException
+// One or more parameters has a value that isn't valid.
+//
+// * ResourceNotFoundException
+// One or more resources can't be found.
+//
+// * ThrottlingException
+// Access is throttled.
+//
+// * SessionLifetimeInMinutesInvalidException
+// The number of minutes specified for the lifetime of a session isn't valid.
+// The session lifetime must be 15-600 minutes.
+//
+// * UnsupportedUserEditionException
+// 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.
+//
+// * UnsupportedPricingPlanException
+// 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.
+//
+// * InternalFailureException
+// An internal failure occurred.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUser
+func (c *QuickSight) GenerateEmbedUrlForAnonymousUser(input *GenerateEmbedUrlForAnonymousUserInput) (*GenerateEmbedUrlForAnonymousUserOutput, error) {
+ req, out := c.GenerateEmbedUrlForAnonymousUserRequest(input)
+ return out, req.Send()
+}
+
+// GenerateEmbedUrlForAnonymousUserWithContext is the same as GenerateEmbedUrlForAnonymousUser with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GenerateEmbedUrlForAnonymousUser for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *QuickSight) GenerateEmbedUrlForAnonymousUserWithContext(ctx aws.Context, input *GenerateEmbedUrlForAnonymousUserInput, opts ...request.Option) (*GenerateEmbedUrlForAnonymousUserOutput, error) {
+ req, out := c.GenerateEmbedUrlForAnonymousUserRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGenerateEmbedUrlForRegisteredUser = "GenerateEmbedUrlForRegisteredUser"
+
+// GenerateEmbedUrlForRegisteredUserRequest generates a "aws/request.Request" representing the
+// client's request for the GenerateEmbedUrlForRegisteredUser operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GenerateEmbedUrlForRegisteredUser for more information on using the GenerateEmbedUrlForRegisteredUser
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GenerateEmbedUrlForRegisteredUserRequest method.
+// req, resp := client.GenerateEmbedUrlForRegisteredUserRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser
+func (c *QuickSight) GenerateEmbedUrlForRegisteredUserRequest(input *GenerateEmbedUrlForRegisteredUserInput) (req *request.Request, output *GenerateEmbedUrlForRegisteredUserOutput) {
+ op := &request.Operation{
+ Name: opGenerateEmbedUrlForRegisteredUser,
+ HTTPMethod: "POST",
+ HTTPPath: "/accounts/{AwsAccountId}/embed-url/registered-user",
+ }
+
+ if input == nil {
+ input = &GenerateEmbedUrlForRegisteredUserInput{}
+ }
+
+ output = &GenerateEmbedUrlForRegisteredUserOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GenerateEmbedUrlForRegisteredUser API operation for Amazon QuickSight.
+//
+// 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 (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-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 (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)
+// 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 (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Amazon QuickSight's
+// API operation GenerateEmbedUrlForRegisteredUser for usage and error information.
+//
+// Returned Error Types:
+// * AccessDeniedException
+// 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.
+//
+// * InvalidParameterValueException
+// One or more parameters has a value that isn't valid.
+//
+// * UserNotFoundException
+// 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.
+//
+// * ResourceNotFoundException
+// One or more resources can't be found.
+//
+// * SessionLifetimeInMinutesInvalidException
+// The number of minutes specified for the lifetime of a session isn't valid.
+// The session lifetime must be 15-600 minutes.
+//
+// * ThrottlingException
+// Access is throttled.
+//
+// * UnsupportedUserEditionException
+// 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.
+//
+// * UnsupportedPricingPlanException
+// 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.
+//
+// * InternalFailureException
+// An internal failure occurred.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser
+func (c *QuickSight) GenerateEmbedUrlForRegisteredUser(input *GenerateEmbedUrlForRegisteredUserInput) (*GenerateEmbedUrlForRegisteredUserOutput, error) {
+ req, out := c.GenerateEmbedUrlForRegisteredUserRequest(input)
+ return out, req.Send()
+}
+
+// GenerateEmbedUrlForRegisteredUserWithContext is the same as GenerateEmbedUrlForRegisteredUser with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GenerateEmbedUrlForRegisteredUser for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *QuickSight) GenerateEmbedUrlForRegisteredUserWithContext(ctx aws.Context, input *GenerateEmbedUrlForRegisteredUserInput, opts ...request.Option) (*GenerateEmbedUrlForRegisteredUserOutput, error) {
+ req, out := c.GenerateEmbedUrlForRegisteredUserRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
const opGetDashboardEmbedUrl = "GetDashboardEmbedUrl"
// GetDashboardEmbedUrlRequest generates a "aws/request.Request" representing the
@@ -6036,6 +6319,10 @@ func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInpu
// For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)
// 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 (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).
+//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
@@ -6088,10 +6375,10 @@ func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInpu
//
// * UnsupportedPricingPlanException
// 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.
+// 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.
@@ -6297,7 +6584,8 @@ func (c *QuickSight) ListAnalysesRequest(input *ListAnalysesInput) (req *request
// ListAnalyses API operation for Amazon QuickSight.
//
-// Lists Amazon QuickSight analyses that exist in the specified AWS account.
+// Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services
+// account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -6601,7 +6889,7 @@ func (c *QuickSight) ListDashboardsRequest(input *ListDashboardsInput) (req *req
// ListDashboards API operation for Amazon QuickSight.
//
-// Lists dashboards in an AWS account.
+// Lists dashboards in an Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -6750,8 +7038,8 @@ func (c *QuickSight) ListDataSetsRequest(input *ListDataSetsInput) (req *request
// ListDataSets API operation for Amazon QuickSight.
//
-// Lists all of the datasets belonging to the current AWS account in an AWS
-// Region.
+// 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/*.
//
@@ -6906,7 +7194,8 @@ func (c *QuickSight) ListDataSourcesRequest(input *ListDataSourcesInput) (req *r
// ListDataSources API operation for Amazon QuickSight.
//
-// Lists data sources in current AWS Region that belong to this AWS account.
+// Lists data sources in current Region; that belong to this Amazon Web Services
+// account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -7836,7 +8125,7 @@ func (c *QuickSight) ListNamespacesRequest(input *ListNamespacesInput) (req *req
// ListNamespaces API operation for Amazon QuickSight.
//
-// Lists the namespaces for the specified AWS account.
+// Lists the namespaces for the specified Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -8656,7 +8945,7 @@ func (c *QuickSight) ListThemeVersionsRequest(input *ListThemeVersionsInput) (re
// ListThemeVersions API operation for Amazon QuickSight.
//
-// Lists all the versions of the themes in the current AWS account.
+// Lists all the versions of the themes in the current Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -8818,7 +9107,7 @@ func (c *QuickSight) ListThemesRequest(input *ListThemesInput) (req *request.Req
// ListThemes API operation for Amazon QuickSight.
//
-// Lists all the themes in the current AWS account.
+// Lists all the themes in the current Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -9394,6 +9683,9 @@ func (c *QuickSight) SearchAnalysesRequest(input *SearchAnalysesInput) (req *req
//
// 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.
+//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
@@ -9549,6 +9841,9 @@ func (c *QuickSight) SearchDashboardsRequest(input *SearchDashboardsInput) (req
//
// 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.
+//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
@@ -9821,8 +10116,7 @@ func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.R
// 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.
+// * QuickSight doesn't currently support the Tag Editor for Resource Groups.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -10015,13 +10309,14 @@ func (c *QuickSight) UpdateAccountCustomizationRequest(input *UpdateAccountCusto
// UpdateAccountCustomization API operation for Amazon QuickSight.
//
-// Updates Amazon QuickSight customizations the current AWS Region. Currently,
+// Updates Amazon QuickSight customizations the current 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -10119,7 +10414,7 @@ func (c *QuickSight) UpdateAccountSettingsRequest(input *UpdateAccountSettingsIn
// UpdateAccountSettings API operation for Amazon QuickSight.
//
-// Updates the Amazon QuickSight settings in your AWS account.
+// Updates the Amazon QuickSight settings in your Amazon Web Services account;.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -10414,7 +10709,11 @@ func (c *QuickSight) UpdateDashboardRequest(input *UpdateDashboardInput) (req *r
// UpdateDashboard API operation for Amazon QuickSight.
//
-// Updates a dashboard in an AWS account.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -12215,7 +12514,7 @@ type AccessDeniedException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -12267,8 +12566,8 @@ func (s *AccessDeniedException) RequestID() string {
return s.RespMetadata.RequestID
}
-// The Amazon QuickSight customizations associated with your AWS account or
-// a QuickSight namespace in a specific AWS Region.
+// The Amazon QuickSight customizations associated with your Amazon Web Services
+// account; or a QuickSight namespace in a specific Region;.
type AccountCustomization struct {
_ struct{} `type:"structure"`
@@ -12292,16 +12591,17 @@ func (s *AccountCustomization) SetDefaultTheme(v string) *AccountCustomization {
return s
}
-// The QuickSight settings associated with your AWS account.
+// The QuickSight settings associated with your Amazon Web Services account;.
type AccountSettings struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
AccountName *string `type:"string"`
- // The default QuickSight namespace for your AWS account.
+ // The default QuickSight namespace for your Amazon Web Services account;.
DefaultNamespace *string `type:"string"`
// The edition of QuickSight that you're currently subscribed to: Enterprise
@@ -12346,7 +12646,7 @@ func (s *AccountSettings) SetNotificationEmail(v string) *AccountSettings {
return s
}
-// The active AWS Identity and Access Management (IAM) policy assignment.
+// The active Identity and Access Management (IAM) policy assignment.
type ActiveIAMPolicyAssignment struct {
_ struct{} `type:"structure"`
@@ -12803,6 +13103,93 @@ func (s *AnalysisSummary) SetStatus(v string) *AnalysisSummary {
return s
}
+// Information about the dashboard that you want to embed.
+type AnonymousUserDashboardEmbeddingConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ //
+ // InitialDashboardId is a required field
+ InitialDashboardId *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s AnonymousUserDashboardEmbeddingConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AnonymousUserDashboardEmbeddingConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AnonymousUserDashboardEmbeddingConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AnonymousUserDashboardEmbeddingConfiguration"}
+ if s.InitialDashboardId == nil {
+ invalidParams.Add(request.NewErrParamRequired("InitialDashboardId"))
+ }
+ if s.InitialDashboardId != nil && len(*s.InitialDashboardId) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("InitialDashboardId", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetInitialDashboardId sets the InitialDashboardId field's value.
+func (s *AnonymousUserDashboardEmbeddingConfiguration) SetInitialDashboardId(v string) *AnonymousUserDashboardEmbeddingConfiguration {
+ s.InitialDashboardId = &v
+ return s
+}
+
+// The type of experience you want to embed. For anonymous users, you can embed
+// an Amazon QuickSight dashboard.
+type AnonymousUserEmbeddingExperienceConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // The type of embedding experience. In this case, an Amazon QuickSight dashboard.
+ Dashboard *AnonymousUserDashboardEmbeddingConfiguration `type:"structure"`
+}
+
+// String returns the string representation
+func (s AnonymousUserEmbeddingExperienceConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AnonymousUserEmbeddingExperienceConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AnonymousUserEmbeddingExperienceConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AnonymousUserEmbeddingExperienceConfiguration"}
+ if s.Dashboard != nil {
+ if err := s.Dashboard.Validate(); err != nil {
+ invalidParams.AddNested("Dashboard", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetDashboard sets the Dashboard field's value.
+func (s *AnonymousUserEmbeddingExperienceConfiguration) SetDashboard(v *AnonymousUserDashboardEmbeddingConfiguration) *AnonymousUserEmbeddingExperienceConfiguration {
+ s.Dashboard = v
+ return s
+}
+
// Amazon Athena parameters.
type AthenaParameters struct {
_ struct{} `type:"structure"`
@@ -12992,7 +13379,7 @@ func (s *AuroraPostgreSqlParameters) SetPort(v int64) *AuroraPostgreSqlParameter
return s
}
-// AWS IoT Analytics parameters.
+// Amazon Web Services IoT Analytics parameters.
type AwsIotAnalyticsParameters struct {
_ struct{} `type:"structure"`
@@ -13139,7 +13526,7 @@ func (s *CalculatedColumn) SetExpression(v string) *CalculatedColumn {
type CancelIngestionInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -13220,7 +13607,7 @@ type CancelIngestionOutput struct {
// An ID for the ingestion.
IngestionId *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -13645,7 +14032,7 @@ type ConflictException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -13700,8 +14087,8 @@ func (s *ConflictException) RequestID() string {
type CreateAccountCustomizationInput struct {
_ struct{} `type:"structure"`
- // The QuickSight customizations you're adding in the current AWS Region. You
- // can add these to an AWS account and a QuickSight namespace.
+ // 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"
@@ -13712,7 +14099,8 @@ type CreateAccountCustomizationInput struct {
// AccountCustomization is a required field
AccountCustomization *AccountCustomization `type:"structure" required:"true"`
- // The ID for the AWS account that you want to customize QuickSight for.
+ // The ID for the Amazon Web Services account; that you want to customize QuickSight
+ // for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -13793,20 +14181,21 @@ func (s *CreateAccountCustomizationInput) SetTags(v []*Tag) *CreateAccountCustom
type CreateAccountCustomizationOutput struct {
_ struct{} `type:"structure"`
- // The QuickSight customizations you're adding in the current AWS Region.
+ // The QuickSight customizations you're adding in the current Region;.
AccountCustomization *AccountCustomization `type:"structure"`
// The Amazon Resource Name (ARN) for the customization that you created for
- // this AWS account.
+ // this Amazon Web Services account;.
Arn *string `type:"string"`
- // The ID for the AWS account that you want to customize QuickSight for.
+ // The ID for the Amazon Web Services account; that you want to customize QuickSight
+ // for.
AwsAccountId *string `min:"12" type:"string"`
// The namespace associated with the customization you're creating.
Namespace *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -13868,7 +14257,7 @@ type CreateAnalysisInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // The ID of the AWS account where you are creating an analysis.
+ // The ID of the Amazon Web Services account; where you are creating an analysis.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -13885,7 +14274,7 @@ type CreateAnalysisInput struct {
// 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
+ // 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.
@@ -14044,7 +14433,7 @@ type CreateAnalysisOutput struct {
// The status of the creation of the analysis.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -14147,7 +14536,7 @@ func (s *CreateColumnsOperation) SetColumns(v []*CalculatedColumn) *CreateColumn
type CreateDashboardInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account where you want to create the dashboard.
+ // The ID of the Amazon Web Services account; where you want to create the dashboard.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -14195,8 +14584,8 @@ type CreateDashboardInput struct {
// 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.
+ // 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
@@ -14211,8 +14600,8 @@ type CreateDashboardInput struct {
// 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.
+ // the source entity. The theme ARN must exist in the same Amazon Web Services
+ // account; where you create the dashboard.
ThemeArn *string `type:"string"`
// A description for the first version of the dashboard being created.
@@ -14371,7 +14760,7 @@ type CreateDashboardOutput struct {
// The ID for the dashboard.
DashboardId *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -14431,7 +14820,7 @@ func (s *CreateDashboardOutput) SetVersionArn(v string) *CreateDashboardOutput {
type CreateDataSetInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -14443,8 +14832,8 @@ type CreateDataSetInput struct {
// A set of one or more definitions of a ColumnLevelPermissionRule .
ColumnLevelPermissionRules []*ColumnLevelPermissionRule `min:"1" type:"list"`
- // An ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // An ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `type:"string" required:"true"`
@@ -14477,6 +14866,10 @@ type CreateDataSetInput struct {
// The row-level security configuration for the data that you want to create.
RowLevelPermissionDataSet *RowLevelPermissionDataSet `type:"structure"`
+ // The configuration of tags on a dataset to set row-level security. Row-level
+ // security tags are currently supported for anonymous embedding only.
+ RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration `type:"structure"`
+
// Contains a map of the key-value pairs for the resource tag or tags assigned
// to the dataset.
Tags []*Tag `min:"1" type:"list"`
@@ -14589,6 +14982,11 @@ func (s *CreateDataSetInput) Validate() error {
invalidParams.AddNested("RowLevelPermissionDataSet", err.(request.ErrInvalidParams))
}
}
+ if s.RowLevelPermissionTagConfiguration != nil {
+ if err := s.RowLevelPermissionTagConfiguration.Validate(); err != nil {
+ invalidParams.AddNested("RowLevelPermissionTagConfiguration", err.(request.ErrInvalidParams))
+ }
+ }
if s.Tags != nil {
for i, v := range s.Tags {
if v == nil {
@@ -14672,6 +15070,12 @@ func (s *CreateDataSetInput) SetRowLevelPermissionDataSet(v *RowLevelPermissionD
return s
}
+// SetRowLevelPermissionTagConfiguration sets the RowLevelPermissionTagConfiguration field's value.
+func (s *CreateDataSetInput) SetRowLevelPermissionTagConfiguration(v *RowLevelPermissionTagConfiguration) *CreateDataSetInput {
+ s.RowLevelPermissionTagConfiguration = v
+ return s
+}
+
// SetTags sets the Tags field's value.
func (s *CreateDataSetInput) SetTags(v []*Tag) *CreateDataSetInput {
s.Tags = v
@@ -14684,8 +15088,8 @@ type CreateDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string `type:"string"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
DataSetId *string `type:"string"`
// The ARN for the ingestion, which is triggered as a result of dataset creation
@@ -14696,7 +15100,7 @@ type CreateDataSetOutput struct {
// if the import mode is SPICE.
IngestionId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -14752,7 +15156,7 @@ func (s *CreateDataSetOutput) SetStatus(v int64) *CreateDataSetOutput {
type CreateDataSourceInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -14761,8 +15165,8 @@ type CreateDataSourceInput struct {
// Currently, only credentials based on user name and password are supported.
Credentials *DataSourceCredentials `type:"structure" sensitive:"true"`
- // An ID for the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // An ID for the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `type:"string" required:"true"`
@@ -14949,11 +15353,11 @@ type CreateDataSourceOutput struct {
// The status of creating the data source.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -15326,8 +15730,9 @@ func (s *CreateFolderOutput) SetStatus(v int64) *CreateFolderOutput {
type CreateGroupInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -15414,8 +15819,9 @@ func (s *CreateGroupInput) SetNamespace(v string) *CreateGroupInput {
type CreateGroupMembershipInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -15510,7 +15916,7 @@ type CreateGroupMembershipOutput struct {
// The group member.
GroupMember *GroupMember `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -15552,7 +15958,7 @@ type CreateGroupOutput struct {
// The name of the group.
Group *Group `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -15591,7 +15997,7 @@ type CreateIAMPolicyAssignmentInput struct {
_ struct{} `type:"structure"`
// The name of the assignment, also called a rule. It must be unique within
- // an AWS account.
+ // an Amazon Web Services account;.
//
// AssignmentName is a required field
AssignmentName *string `min:"1" type:"string" required:"true"`
@@ -15609,8 +16015,8 @@ type CreateIAMPolicyAssignmentInput struct {
// AssignmentStatus is a required field
AssignmentStatus *string `type:"string" required:"true" enum:"AssignmentStatus"`
- // The ID of the AWS account where you want to assign an IAM policy to QuickSight
- // users or groups.
+ // The ID of the Amazon Web Services account; where you want to assign an IAM
+ // policy to QuickSight users or groups.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -15712,7 +16118,8 @@ type CreateIAMPolicyAssignmentOutput struct {
// The ID for the assignment.
AssignmentId *string `type:"string"`
- // The name of the assignment. This name must be unique within the AWS account.
+ // The name of the assignment. This name must be unique within the Amazon Web
+ // Services account;.
AssignmentName *string `min:"1" type:"string"`
// The status of the assignment. Possible values are as follows:
@@ -15733,7 +16140,7 @@ type CreateIAMPolicyAssignmentOutput struct {
// specified in this assignment.
PolicyArn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -15795,7 +16202,7 @@ func (s *CreateIAMPolicyAssignmentOutput) SetStatus(v int64) *CreateIAMPolicyAss
type CreateIngestionInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -15879,7 +16286,7 @@ type CreateIngestionOutput struct {
// The ingestion status.
IngestionStatus *string `type:"string" enum:"IngestionStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -15929,8 +16336,8 @@ func (s *CreateIngestionOutput) SetStatus(v int64) *CreateIngestionOutput {
type CreateNamespaceInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that you want to create the QuickSight namespace
- // in.
+ // The ID for the Amazon Web Services account; that you want to create the QuickSight
+ // namespace in.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -16025,7 +16432,7 @@ type CreateNamespaceOutput struct {
// The ARN of the QuickSight namespace you created.
Arn *string `type:"string"`
- // The AWS Region that you want to use for the free SPICE capacity for the new
+ // 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.
CapacityRegion *string `type:"string"`
@@ -16042,7 +16449,7 @@ type CreateNamespaceOutput struct {
// The name of the new namespace that you created.
Name *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -16106,13 +16513,13 @@ type CreateTemplateAliasInput struct {
// 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.
+ // $ are reserved by Amazon QuickSight.
//
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the template that you creating an
- // alias for.
+ // The ID of the Amazon Web Services account; that contains the template that
+ // you creating an alias for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -16199,7 +16606,7 @@ func (s *CreateTemplateAliasInput) SetTemplateVersionNumber(v int64) *CreateTemp
type CreateTemplateAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -16240,8 +16647,9 @@ func (s *CreateTemplateAliasOutput) SetTemplateAlias(v *TemplateAlias) *CreateTe
type CreateTemplateInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -16257,8 +16665,8 @@ type CreateTemplateInput struct {
// 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.
+ // 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.
@@ -16272,7 +16680,7 @@ type CreateTemplateInput struct {
Tags []*Tag `min:"1" type:"list"`
// An ID for the template that you want to create. This template is unique per
- // AWS Region in each AWS account.
+ // Region; in each Amazon Web Services account;.
//
// TemplateId is a required field
TemplateId *string `location:"uri" locationName:"TemplateId" min:"1" type:"string" required:"true"`
@@ -16407,7 +16815,7 @@ type CreateTemplateOutput struct {
// The template creation status.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -16477,7 +16885,8 @@ type CreateThemeAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the theme for the new theme alias.
+ // The ID of the Amazon Web Services account; that contains the theme for the
+ // new theme alias.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -16564,7 +16973,7 @@ func (s *CreateThemeAliasInput) SetThemeVersionNumber(v int64) *CreateThemeAlias
type CreateThemeAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -16605,7 +17014,8 @@ func (s *CreateThemeAliasOutput) SetThemeAlias(v *ThemeAlias) *CreateThemeAliasO
type CreateThemeInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account where you want to store the new theme.
+ // The ID of the Amazon Web Services account; where you want to store the new
+ // theme.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -16635,8 +17045,8 @@ type CreateThemeInput struct {
// add to the resource.
Tags []*Tag `min:"1" type:"list"`
- // An ID for the theme that you want to create. The theme ID is unique per AWS
- // Region in each AWS account.
+ // An ID for the theme that you want to create. The theme ID is unique per Region;
+ // in each Amazon Web Services account;.
//
// ThemeId is a required field
ThemeId *string `location:"uri" locationName:"ThemeId" min:"1" type:"string" required:"true"`
@@ -16780,7 +17190,7 @@ type CreateThemeOutput struct {
// The theme creation status.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -17689,6 +18099,9 @@ type DataSet struct {
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet `type:"structure"`
+
+ // The element you can use to define tags for row-level security.
+ RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration `type:"structure"`
}
// String returns the string representation
@@ -17785,6 +18198,12 @@ func (s *DataSet) SetRowLevelPermissionDataSet(v *RowLevelPermissionDataSet) *Da
return s
}
+// SetRowLevelPermissionTagConfiguration sets the RowLevelPermissionTagConfiguration field's value.
+func (s *DataSet) SetRowLevelPermissionTagConfiguration(v *RowLevelPermissionTagConfiguration) *DataSet {
+ s.RowLevelPermissionTagConfiguration = v
+ return s
+}
+
// Dataset configuration.
type DataSetConfiguration struct {
_ struct{} `type:"structure"`
@@ -17931,6 +18350,9 @@ type DataSetSummary struct {
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet `type:"structure"`
+
+ // Whether or not the row level permission tags are applied.
+ RowLevelPermissionTagConfigurationApplied *bool `type:"boolean"`
}
// String returns the string representation
@@ -17991,6 +18413,12 @@ func (s *DataSetSummary) SetRowLevelPermissionDataSet(v *RowLevelPermissionDataS
return s
}
+// SetRowLevelPermissionTagConfigurationApplied sets the RowLevelPermissionTagConfigurationApplied field's value.
+func (s *DataSetSummary) SetRowLevelPermissionTagConfigurationApplied(v bool) *DataSetSummary {
+ s.RowLevelPermissionTagConfigurationApplied = &v
+ return s
+}
+
// The structure of a data source.
type DataSource struct {
_ struct{} `type:"structure"`
@@ -18012,8 +18440,8 @@ type DataSource struct {
// The time that this data source was created.
CreatedTime *time.Time `type:"timestamp"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
// The parameters that Amazon QuickSight uses to connect to your underlying
@@ -18232,7 +18660,7 @@ type DataSourceParameters struct {
// Aurora PostgreSQL parameters.
AuroraPostgreSqlParameters *AuroraPostgreSqlParameters `type:"structure"`
- // AWS IoT Analytics parameters.
+ // Amazon Web Services IoT Analytics parameters.
AwsIotAnalyticsParameters *AwsIotAnalyticsParameters `type:"structure"`
// Jira parameters.
@@ -18630,8 +19058,8 @@ func (s *DecimalParameter) SetValues(v []*float64) *DecimalParameter {
type DeleteAccountCustomizationInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that you want to delete QuickSight customizations
- // from in this AWS Region.
+ // The ID for the Amazon Web Services account; that you want to delete QuickSight
+ // customizations from in this Region;.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -18681,7 +19109,7 @@ func (s *DeleteAccountCustomizationInput) SetNamespace(v string) *DeleteAccountC
type DeleteAccountCustomizationOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -18718,7 +19146,7 @@ type DeleteAnalysisInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // The ID of the AWS account where you want to delete an analysis.
+ // The ID of the Amazon Web Services account; where you want to delete an analysis.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -18805,7 +19233,7 @@ type DeleteAnalysisOutput struct {
// The date and time that the analysis is scheduled to be deleted.
DeletionTime *time.Time `type:"timestamp"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -18855,7 +19283,8 @@ func (s *DeleteAnalysisOutput) SetStatus(v int64) *DeleteAnalysisOutput {
type DeleteDashboardInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard that you're deleting.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're deleting.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -18932,7 +19361,7 @@ type DeleteDashboardOutput struct {
// The ID of the dashboard.
DashboardId *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -18976,13 +19405,13 @@ func (s *DeleteDashboardOutput) SetStatus(v int64) *DeleteDashboardOutput {
type DeleteDataSetInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `location:"uri" locationName:"DataSetId" type:"string" required:"true"`
@@ -19038,11 +19467,11 @@ type DeleteDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string `type:"string"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
DataSetId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19086,13 +19515,13 @@ func (s *DeleteDataSetOutput) SetStatus(v int64) *DeleteDataSetOutput {
type DeleteDataSourceInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `location:"uri" locationName:"DataSourceId" type:"string" required:"true"`
@@ -19148,11 +19577,11 @@ type DeleteDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source that you deleted.
Arn *string `type:"string"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19429,8 +19858,9 @@ func (s *DeleteFolderOutput) SetStatus(v int64) *DeleteFolderOutput {
type DeleteGroupInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -19505,8 +19935,9 @@ func (s *DeleteGroupInput) SetNamespace(v string) *DeleteGroupInput {
type DeleteGroupMembershipInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -19598,7 +20029,7 @@ func (s *DeleteGroupMembershipInput) SetNamespace(v string) *DeleteGroupMembersh
type DeleteGroupMembershipOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19630,7 +20061,7 @@ func (s *DeleteGroupMembershipOutput) SetStatus(v int64) *DeleteGroupMembershipO
type DeleteGroupOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19667,7 +20098,8 @@ type DeleteIAMPolicyAssignmentInput struct {
// AssignmentName is a required field
AssignmentName *string `location:"uri" locationName:"AssignmentName" min:"1" type:"string" required:"true"`
- // The AWS account ID where you want to delete the IAM policy assignment.
+ // The Amazon Web Services account; ID where you want to delete the IAM policy
+ // assignment.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -19740,7 +20172,7 @@ type DeleteIAMPolicyAssignmentOutput struct {
// The name of the assignment.
AssignmentName *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19778,8 +20210,8 @@ func (s *DeleteIAMPolicyAssignmentOutput) SetStatus(v int64) *DeleteIAMPolicyAss
type DeleteNamespaceInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that you want to delete the QuickSight namespace
- // from.
+ // The ID for the Amazon Web Services account; that you want to delete the QuickSight
+ // namespace from.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -19837,7 +20269,7 @@ func (s *DeleteNamespaceInput) SetNamespace(v string) *DeleteNamespaceInput {
type DeleteNamespaceOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -19877,7 +20309,7 @@ type DeleteTemplateAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the item to delete.
+ // The ID of the Amazon Web Services account; that contains the item to delete.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -19953,7 +20385,7 @@ type DeleteTemplateAliasOutput struct {
// The Amazon Resource Name (ARN) of the template you want to delete.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20006,7 +20438,8 @@ func (s *DeleteTemplateAliasOutput) SetTemplateId(v string) *DeleteTemplateAlias
type DeleteTemplateInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the template that you're deleting.
+ // The ID of the Amazon Web Services account; that contains the template that
+ // you're deleting.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20080,7 +20513,7 @@ type DeleteTemplateOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20132,7 +20565,8 @@ type DeleteThemeAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the theme alias to delete.
+ // The ID of the Amazon Web Services account; that contains the theme alias
+ // to delete.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20208,7 +20642,7 @@ type DeleteThemeAliasOutput struct {
// The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20261,7 +20695,8 @@ func (s *DeleteThemeAliasOutput) SetThemeId(v string) *DeleteThemeAliasOutput {
type DeleteThemeInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the theme that you're deleting.
+ // The ID of the Amazon Web Services account; that contains the theme that you're
+ // deleting.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20337,7 +20772,7 @@ type DeleteThemeOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20384,8 +20819,9 @@ func (s *DeleteThemeOutput) SetThemeId(v string) *DeleteThemeOutput {
type DeleteUserByPrincipalIdInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20460,7 +20896,7 @@ func (s *DeleteUserByPrincipalIdInput) SetPrincipalId(v string) *DeleteUserByPri
type DeleteUserByPrincipalIdOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20492,8 +20928,9 @@ func (s *DeleteUserByPrincipalIdOutput) SetStatus(v int64) *DeleteUserByPrincipa
type DeleteUserInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20568,7 +21005,7 @@ func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput {
type DeleteUserOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20600,8 +21037,8 @@ func (s *DeleteUserOutput) SetStatus(v int64) *DeleteUserOutput {
type DescribeAccountCustomizationInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that you want to describe QuickSight customizations
- // for.
+ // The ID for the Amazon Web Services account; that you want to describe QuickSight
+ // customizations for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20665,20 +21102,20 @@ func (s *DescribeAccountCustomizationInput) SetResolved(v bool) *DescribeAccount
type DescribeAccountCustomizationOutput struct {
_ struct{} `type:"structure"`
- // The QuickSight customizations that exist in the current AWS Region.
+ // The QuickSight customizations that exist in the current Region;.
AccountCustomization *AccountCustomization `type:"structure"`
// The Amazon Resource Name (ARN) of the customization that's associated with
- // this AWS account.
+ // this Amazon Web Services account;.
Arn *string `type:"string"`
- // The ID for the AWS account that you're describing.
+ // The ID for the Amazon Web Services account; that you're describing.
AwsAccountId *string `min:"12" type:"string"`
// The QuickSight namespace that you're describing.
Namespace *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20734,7 +21171,8 @@ func (s *DescribeAccountCustomizationOutput) SetStatus(v int64) *DescribeAccount
type DescribeAccountSettingsInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that contains the settings that you want to list.
+ // The ID for the Amazon Web Services account; that contains the settings that
+ // you want to list.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20775,17 +21213,17 @@ func (s *DescribeAccountSettingsInput) SetAwsAccountId(v string) *DescribeAccoun
type DescribeAccountSettingsOutput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
AccountSettings *AccountSettings `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20829,8 +21267,8 @@ type DescribeAnalysisInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the analysis. You must be using the
- // AWS account that the analysis is in.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20887,7 +21325,7 @@ type DescribeAnalysisOutput struct {
// you're describing.
Analysis *Analysis `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -20931,8 +21369,9 @@ type DescribeAnalysisPermissionsInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -20995,7 +21434,7 @@ type DescribeAnalysisPermissionsOutput struct {
// on an analysis.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -21048,7 +21487,8 @@ type DescribeDashboardInput struct {
// The alias name.
AliasName *string `location:"querystring" locationName:"alias-name" min:"1" type:"string"`
- // The ID of the AWS account that contains the dashboard that you're describing.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -21131,7 +21571,7 @@ type DescribeDashboardOutput struct {
// Information about the dashboard.
Dashboard *Dashboard `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of this request.
@@ -21169,8 +21609,8 @@ func (s *DescribeDashboardOutput) SetStatus(v int64) *DescribeDashboardOutput {
type DescribeDashboardPermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard that you're describing
- // permissions for.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're describing permissions for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -21237,7 +21677,7 @@ type DescribeDashboardPermissionsOutput struct {
// A structure that contains the permissions for the dashboard.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -21287,13 +21727,13 @@ func (s *DescribeDashboardPermissionsOutput) SetStatus(v int64) *DescribeDashboa
type DescribeDataSetInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `location:"uri" locationName:"DataSetId" type:"string" required:"true"`
@@ -21349,7 +21789,7 @@ type DescribeDataSetOutput struct {
// Information on the dataset.
DataSet *DataSet `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -21387,13 +21827,13 @@ func (s *DescribeDataSetOutput) SetStatus(v int64) *DescribeDataSetOutput {
type DescribeDataSetPermissionsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `location:"uri" locationName:"DataSetId" type:"string" required:"true"`
@@ -21449,14 +21889,14 @@ type DescribeDataSetPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DataSetArn *string `type:"string"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
DataSetId *string `type:"string"`
// A list of resource permissions on the dataset.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -21506,13 +21946,13 @@ func (s *DescribeDataSetPermissionsOutput) SetStatus(v int64) *DescribeDataSetPe
type DescribeDataSourceInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `location:"uri" locationName:"DataSourceId" type:"string" required:"true"`
@@ -21568,7 +22008,7 @@ type DescribeDataSourceOutput struct {
// The information on the data source.
DataSource *DataSource `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -21606,13 +22046,13 @@ func (s *DescribeDataSourceOutput) SetStatus(v int64) *DescribeDataSourceOutput
type DescribeDataSourcePermissionsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `location:"uri" locationName:"DataSourceId" type:"string" required:"true"`
@@ -21668,14 +22108,14 @@ type DescribeDataSourcePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the data source.
DataSourceArn *string `type:"string"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
// A list of resource permissions on the data source.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22058,8 +22498,9 @@ func (s *DescribeFolderResolvedPermissionsOutput) SetStatus(v int64) *DescribeFo
type DescribeGroupInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22137,7 +22578,7 @@ type DescribeGroupOutput struct {
// The name of the group.
Group *Group `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22180,7 +22621,8 @@ type DescribeIAMPolicyAssignmentInput struct {
// AssignmentName is a required field
AssignmentName *string `location:"uri" locationName:"AssignmentName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the assignment that you want to describe.
+ // The ID of the Amazon Web Services account; that contains the assignment that
+ // you want to describe.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22253,7 +22695,7 @@ type DescribeIAMPolicyAssignmentOutput struct {
// Information describing the IAM policy assignment.
IAMPolicyAssignment *IAMPolicyAssignment `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22291,7 +22733,7 @@ func (s *DescribeIAMPolicyAssignmentOutput) SetStatus(v int64) *DescribeIAMPolic
type DescribeIngestionInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22369,7 +22811,7 @@ type DescribeIngestionOutput struct {
// Information about the ingestion.
Ingestion *Ingestion `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22407,8 +22849,8 @@ func (s *DescribeIngestionOutput) SetStatus(v int64) *DescribeIngestionOutput {
type DescribeNamespaceInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that contains the QuickSight namespace that you
- // want to describe.
+ // The ID for the Amazon Web Services account; that contains the QuickSight
+ // namespace that you want to describe.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22467,13 +22909,13 @@ type DescribeNamespaceOutput struct {
_ struct{} `type:"structure"`
// The information about the namespace that you're describing. The response
- // includes the namespace ARN, name, AWS Region, creation status, and identity
+ // 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.
Namespace *NamespaceInfoV2 `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22519,7 +22961,8 @@ type DescribeTemplateAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the template alias that you're describing.
+ // The ID of the Amazon Web Services account; that contains the template alias
+ // that you're describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22589,7 +23032,7 @@ func (s *DescribeTemplateAliasInput) SetTemplateId(v string) *DescribeTemplateAl
type DescribeTemplateAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22636,7 +23079,8 @@ type DescribeTemplateInput struct {
// AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
AliasName *string `location:"querystring" locationName:"alias-name" min:"1" type:"string"`
- // The ID of the AWS account that contains the template that you're describing.
+ // The ID of the Amazon Web Services account; that contains the template that
+ // you're describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22716,7 +23160,7 @@ func (s *DescribeTemplateInput) SetVersionNumber(v int64) *DescribeTemplateInput
type DescribeTemplateOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22757,7 +23201,8 @@ func (s *DescribeTemplateOutput) SetTemplate(v *Template) *DescribeTemplateOutpu
type DescribeTemplatePermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the template that you're describing.
+ // The ID of the Amazon Web Services account; that contains the template that
+ // you're describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22818,7 +23263,7 @@ type DescribeTemplatePermissionsOutput struct {
// A list of resource permissions to be set on the template.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22879,7 +23324,8 @@ type DescribeThemeAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the theme alias that you're describing.
+ // The ID of the Amazon Web Services account; that contains the theme alias
+ // that you're describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -22949,7 +23395,7 @@ func (s *DescribeThemeAliasInput) SetThemeId(v string) *DescribeThemeAliasInput
type DescribeThemeAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -22996,7 +23442,8 @@ type DescribeThemeInput struct {
// parameter. The keyword $PUBLISHED doesn't apply to themes.
AliasName *string `location:"querystring" locationName:"alias-name" min:"1" type:"string"`
- // The ID of the AWS account that contains the theme that you're describing.
+ // The ID of the Amazon Web Services account; that contains the theme that you're
+ // describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" type:"string" required:"true"`
@@ -23076,7 +23523,7 @@ func (s *DescribeThemeInput) SetVersionNumber(v int64) *DescribeThemeInput {
type DescribeThemeOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -23117,7 +23564,8 @@ func (s *DescribeThemeOutput) SetTheme(v *Theme) *DescribeThemeOutput {
type DescribeThemePermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the theme that you're describing.
+ // The ID of the Amazon Web Services account; that contains the theme that you're
+ // describing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -23178,7 +23626,7 @@ type DescribeThemePermissionsOutput struct {
// A list of resource permissions set on the theme.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -23234,8 +23682,9 @@ func (s *DescribeThemePermissionsOutput) SetThemeId(v string) *DescribeThemePerm
type DescribeUserInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -23310,7 +23759,7 @@ func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput {
type DescribeUserOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -23356,7 +23805,7 @@ type DomainNotWhitelistedException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -23766,6 +24215,324 @@ func (s *FolderSummary) SetName(v string) *FolderSummary {
return s
}
+type GenerateEmbedUrlForAnonymousUserInput struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ //
+ // AuthorizedResourceArns is a required field
+ AuthorizedResourceArns []*string `type:"list" required:"true"`
+
+ // The ID for the Amazon Web Services account that contains the dashboard that
+ // you're embedding.
+ //
+ // AwsAccountId is a required field
+ AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
+
+ // The configuration of the experience you are embedding.
+ //
+ // ExperienceConfiguration is a required field
+ ExperienceConfiguration *AnonymousUserEmbeddingExperienceConfiguration `type:"structure" required:"true"`
+
+ // 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.
+ //
+ // Namespace is a required field
+ Namespace *string `type:"string" required:"true"`
+
+ // How many minutes the session is valid. The session lifetime must be in [15-600]
+ // minutes range.
+ SessionLifetimeInMinutes *int64 `min:"15" type:"long"`
+
+ // 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
+ // (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html).
+ SessionTags []*SessionTag `min:"1" type:"list"`
+}
+
+// String returns the string representation
+func (s GenerateEmbedUrlForAnonymousUserInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GenerateEmbedUrlForAnonymousUserInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GenerateEmbedUrlForAnonymousUserInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GenerateEmbedUrlForAnonymousUserInput"}
+ if s.AuthorizedResourceArns == nil {
+ invalidParams.Add(request.NewErrParamRequired("AuthorizedResourceArns"))
+ }
+ if s.AwsAccountId == nil {
+ invalidParams.Add(request.NewErrParamRequired("AwsAccountId"))
+ }
+ if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 {
+ invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12))
+ }
+ if s.ExperienceConfiguration == nil {
+ invalidParams.Add(request.NewErrParamRequired("ExperienceConfiguration"))
+ }
+ if s.Namespace == nil {
+ invalidParams.Add(request.NewErrParamRequired("Namespace"))
+ }
+ if s.SessionLifetimeInMinutes != nil && *s.SessionLifetimeInMinutes < 15 {
+ invalidParams.Add(request.NewErrParamMinValue("SessionLifetimeInMinutes", 15))
+ }
+ if s.SessionTags != nil && len(s.SessionTags) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("SessionTags", 1))
+ }
+ if s.ExperienceConfiguration != nil {
+ if err := s.ExperienceConfiguration.Validate(); err != nil {
+ invalidParams.AddNested("ExperienceConfiguration", err.(request.ErrInvalidParams))
+ }
+ }
+ if s.SessionTags != nil {
+ for i, v := range s.SessionTags {
+ if v == nil {
+ continue
+ }
+ if err := v.Validate(); err != nil {
+ invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SessionTags", i), err.(request.ErrInvalidParams))
+ }
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetAuthorizedResourceArns sets the AuthorizedResourceArns field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetAuthorizedResourceArns(v []*string) *GenerateEmbedUrlForAnonymousUserInput {
+ s.AuthorizedResourceArns = v
+ return s
+}
+
+// SetAwsAccountId sets the AwsAccountId field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetAwsAccountId(v string) *GenerateEmbedUrlForAnonymousUserInput {
+ s.AwsAccountId = &v
+ return s
+}
+
+// SetExperienceConfiguration sets the ExperienceConfiguration field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetExperienceConfiguration(v *AnonymousUserEmbeddingExperienceConfiguration) *GenerateEmbedUrlForAnonymousUserInput {
+ s.ExperienceConfiguration = v
+ return s
+}
+
+// SetNamespace sets the Namespace field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetNamespace(v string) *GenerateEmbedUrlForAnonymousUserInput {
+ s.Namespace = &v
+ return s
+}
+
+// SetSessionLifetimeInMinutes sets the SessionLifetimeInMinutes field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetSessionLifetimeInMinutes(v int64) *GenerateEmbedUrlForAnonymousUserInput {
+ s.SessionLifetimeInMinutes = &v
+ return s
+}
+
+// SetSessionTags sets the SessionTags field's value.
+func (s *GenerateEmbedUrlForAnonymousUserInput) SetSessionTags(v []*SessionTag) *GenerateEmbedUrlForAnonymousUserInput {
+ s.SessionTags = v
+ return s
+}
+
+type GenerateEmbedUrlForAnonymousUserOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The embed URL for the dashboard.
+ //
+ // EmbedUrl is a required field
+ EmbedUrl *string `type:"string" required:"true" sensitive:"true"`
+
+ // The Amazon Web Services request ID for this operation.
+ //
+ // RequestId is a required field
+ RequestId *string `type:"string" required:"true"`
+
+ // The HTTP status of the request.
+ //
+ // Status is a required field
+ Status *int64 `location:"statusCode" type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s GenerateEmbedUrlForAnonymousUserOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GenerateEmbedUrlForAnonymousUserOutput) GoString() string {
+ return s.String()
+}
+
+// SetEmbedUrl sets the EmbedUrl field's value.
+func (s *GenerateEmbedUrlForAnonymousUserOutput) SetEmbedUrl(v string) *GenerateEmbedUrlForAnonymousUserOutput {
+ s.EmbedUrl = &v
+ return s
+}
+
+// SetRequestId sets the RequestId field's value.
+func (s *GenerateEmbedUrlForAnonymousUserOutput) SetRequestId(v string) *GenerateEmbedUrlForAnonymousUserOutput {
+ s.RequestId = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *GenerateEmbedUrlForAnonymousUserOutput) SetStatus(v int64) *GenerateEmbedUrlForAnonymousUserOutput {
+ s.Status = &v
+ return s
+}
+
+type GenerateEmbedUrlForRegisteredUserInput struct {
+ _ struct{} `type:"structure"`
+
+ // The ID for the Amazon Web Services account that contains the dashboard that
+ // you're embedding.
+ //
+ // AwsAccountId is a required field
+ AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
+
+ // The experience you are embedding. For registered users, you can embed Amazon
+ // QuickSight dashboards or the entire Amazon QuickSight console.
+ //
+ // ExperienceConfiguration is a required field
+ ExperienceConfiguration *RegisteredUserEmbeddingExperienceConfiguration `type:"structure" required:"true"`
+
+ // How many minutes the session is valid. The session lifetime must be in [15-600]
+ // minutes range.
+ SessionLifetimeInMinutes *int64 `min:"15" type:"long"`
+
+ // The Amazon Resource Name for the registered user.
+ //
+ // UserArn is a required field
+ UserArn *string `type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GenerateEmbedUrlForRegisteredUserInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GenerateEmbedUrlForRegisteredUserInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GenerateEmbedUrlForRegisteredUserInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GenerateEmbedUrlForRegisteredUserInput"}
+ if s.AwsAccountId == nil {
+ invalidParams.Add(request.NewErrParamRequired("AwsAccountId"))
+ }
+ if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 {
+ invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12))
+ }
+ if s.ExperienceConfiguration == nil {
+ invalidParams.Add(request.NewErrParamRequired("ExperienceConfiguration"))
+ }
+ if s.SessionLifetimeInMinutes != nil && *s.SessionLifetimeInMinutes < 15 {
+ invalidParams.Add(request.NewErrParamMinValue("SessionLifetimeInMinutes", 15))
+ }
+ if s.UserArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("UserArn"))
+ }
+ if s.ExperienceConfiguration != nil {
+ if err := s.ExperienceConfiguration.Validate(); err != nil {
+ invalidParams.AddNested("ExperienceConfiguration", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetAwsAccountId sets the AwsAccountId field's value.
+func (s *GenerateEmbedUrlForRegisteredUserInput) SetAwsAccountId(v string) *GenerateEmbedUrlForRegisteredUserInput {
+ s.AwsAccountId = &v
+ return s
+}
+
+// SetExperienceConfiguration sets the ExperienceConfiguration field's value.
+func (s *GenerateEmbedUrlForRegisteredUserInput) SetExperienceConfiguration(v *RegisteredUserEmbeddingExperienceConfiguration) *GenerateEmbedUrlForRegisteredUserInput {
+ s.ExperienceConfiguration = v
+ return s
+}
+
+// SetSessionLifetimeInMinutes sets the SessionLifetimeInMinutes field's value.
+func (s *GenerateEmbedUrlForRegisteredUserInput) SetSessionLifetimeInMinutes(v int64) *GenerateEmbedUrlForRegisteredUserInput {
+ s.SessionLifetimeInMinutes = &v
+ return s
+}
+
+// SetUserArn sets the UserArn field's value.
+func (s *GenerateEmbedUrlForRegisteredUserInput) SetUserArn(v string) *GenerateEmbedUrlForRegisteredUserInput {
+ s.UserArn = &v
+ return s
+}
+
+type GenerateEmbedUrlForRegisteredUserOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The embed URL for the Amazon QuickSight dashboard or console.
+ //
+ // EmbedUrl is a required field
+ EmbedUrl *string `type:"string" required:"true" sensitive:"true"`
+
+ // The Amazon Web Services request ID for this operation.
+ //
+ // RequestId is a required field
+ RequestId *string `type:"string" required:"true"`
+
+ // The HTTP status of the request.
+ //
+ // Status is a required field
+ Status *int64 `location:"statusCode" type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s GenerateEmbedUrlForRegisteredUserOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GenerateEmbedUrlForRegisteredUserOutput) GoString() string {
+ return s.String()
+}
+
+// SetEmbedUrl sets the EmbedUrl field's value.
+func (s *GenerateEmbedUrlForRegisteredUserOutput) SetEmbedUrl(v string) *GenerateEmbedUrlForRegisteredUserOutput {
+ s.EmbedUrl = &v
+ return s
+}
+
+// SetRequestId sets the RequestId field's value.
+func (s *GenerateEmbedUrlForRegisteredUserOutput) SetRequestId(v string) *GenerateEmbedUrlForRegisteredUserOutput {
+ s.RequestId = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *GenerateEmbedUrlForRegisteredUserOutput) SetStatus(v int64) *GenerateEmbedUrlForRegisteredUserOutput {
+ s.Status = &v
+ return s
+}
+
// Geospatial column group that denotes a hierarchy.
type GeoSpatialColumnGroup struct {
_ struct{} `type:"structure"`
@@ -23850,12 +24617,13 @@ type GetDashboardEmbedUrlInput struct {
// dashboards.
AdditionalDashboardIds []*string `location:"querystring" locationName:"additional-dashboard-ids" min:"1" type:"list"`
- // The ID for the AWS account that contains the dashboard that you're embedding.
+ // The ID for the Amazon Web Services account; that contains the dashboard that
+ // you're embedding.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID for the dashboard, also added to the AWS Identity and Access Management
+ // The ID for the dashboard, also added to the Identity and Access Management
// (IAM) policy.
//
// DashboardId is a required field
@@ -23866,8 +24634,8 @@ type GetDashboardEmbedUrlInput struct {
// IdentityType is a required field
IdentityType *string `location:"querystring" locationName:"creds-type" type:"string" required:"true" enum:"EmbeddingIdentityType"`
- // 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.
Namespace *string `location:"querystring" locationName:"namespace" type:"string"`
// Remove the reset button on the embedded dashboard. The default is FALSE,
@@ -24018,7 +24786,7 @@ type GetDashboardEmbedUrlOutput struct {
// a user session that is valid for 10 hours.
EmbedUrl *string `type:"string" sensitive:"true"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -24056,7 +24824,8 @@ func (s *GetDashboardEmbedUrlOutput) SetStatus(v int64) *GetDashboardEmbedUrlOut
type GetSessionEmbedUrlInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account associated with your QuickSight subscription.
+ // The ID for the Amazon Web Services account; associated with your QuickSight
+ // subscription.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -24092,9 +24861,8 @@ type GetSessionEmbedUrlInput struct {
//
// 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
+ // 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.
@@ -24166,7 +24934,7 @@ type GetSessionEmbedUrlOutput struct {
// sign-on to a user session that is valid for 10 hours.
EmbedUrl *string `type:"string" sensitive:"true"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -24312,7 +25080,7 @@ func (s *GutterStyle) SetShow(v bool) *GutterStyle {
return s
}
-// An AWS Identity and Access Management (IAM) policy assignment.
+// An Identity and Access Management (IAM) policy assignment.
type IAMPolicyAssignment struct {
_ struct{} `type:"structure"`
@@ -24325,7 +25093,7 @@ type IAMPolicyAssignment struct {
// Assignment status.
AssignmentStatus *string `type:"string" enum:"AssignmentStatus"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
AwsAccountId *string `min:"12" type:"string"`
// Identities.
@@ -24422,7 +25190,7 @@ type IdentityTypeNotSupportedException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -24710,7 +25478,7 @@ type InternalFailureException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -24769,7 +25537,7 @@ type InvalidNextTokenException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -24828,7 +25596,7 @@ type InvalidParameterValueException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -25062,7 +25830,7 @@ type LimitExceededException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
// Limit exceeded.
@@ -25120,7 +25888,7 @@ func (s *LimitExceededException) RequestID() string {
type ListAnalysesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the analyses.
+ // The ID of the Amazon Web Services account; that contains the analyses.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -25188,7 +25956,7 @@ type ListAnalysesOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -25232,8 +26000,8 @@ func (s *ListAnalysesOutput) SetStatus(v int64) *ListAnalysesOutput {
type ListDashboardVersionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard that you're listing
- // versions for.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're listing versions for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -25318,7 +26086,7 @@ type ListDashboardVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -25362,7 +26130,8 @@ func (s *ListDashboardVersionsOutput) SetStatus(v int64) *ListDashboardVersionsO
type ListDashboardsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboards that you're listing.
+ // The ID of the Amazon Web Services account; that contains the dashboards that
+ // you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -25424,14 +26193,14 @@ func (s *ListDashboardsInput) SetNextToken(v string) *ListDashboardsInput {
type ListDashboardsOutput struct {
_ struct{} `type:"structure"`
- // A structure that contains all of the dashboards in your AWS account. This
- // structure provides basic information about the dashboards.
+ // A structure that contains all of the dashboards in your Amazon Web Services
+ // account;. This structure provides basic information about the dashboards.
DashboardSummaryList []*DashboardSummary `type:"list"`
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -25475,7 +26244,7 @@ func (s *ListDashboardsOutput) SetStatus(v int64) *ListDashboardsOutput {
type ListDataSetsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -25543,7 +26312,7 @@ type ListDataSetsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -25587,7 +26356,7 @@ func (s *ListDataSetsOutput) SetStatus(v int64) *ListDataSetsOutput {
type ListDataSourcesInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -25655,7 +26424,7 @@ type ListDataSourcesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -25942,8 +26711,9 @@ func (s *ListFoldersOutput) SetStatus(v int64) *ListFoldersOutput {
type ListGroupMembershipsInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26045,7 +26815,7 @@ type ListGroupMembershipsOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26089,8 +26859,9 @@ func (s *ListGroupMembershipsOutput) SetStatus(v int64) *ListGroupMembershipsOut
type ListGroupsInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26175,7 +26946,7 @@ type ListGroupsOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26219,7 +26990,7 @@ func (s *ListGroupsOutput) SetStatus(v int64) *ListGroupsOutput {
type ListIAMPolicyAssignmentsForUserInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the assignments.
+ // The ID of the Amazon Web Services account; that contains the assignments.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26321,7 +27092,7 @@ type ListIAMPolicyAssignmentsForUserOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26368,7 +27139,8 @@ type ListIAMPolicyAssignmentsInput struct {
// The status of the assignments.
AssignmentStatus *string `type:"string" enum:"AssignmentStatus"`
- // The ID of the AWS account that contains these IAM policy assignments.
+ // The ID of the Amazon Web Services account; that contains these IAM policy
+ // assignments.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26459,7 +27231,7 @@ type ListIAMPolicyAssignmentsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26503,7 +27275,7 @@ func (s *ListIAMPolicyAssignmentsOutput) SetStatus(v int64) *ListIAMPolicyAssign
type ListIngestionsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26588,7 +27360,7 @@ type ListIngestionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26632,8 +27404,8 @@ func (s *ListIngestionsOutput) SetStatus(v int64) *ListIngestionsOutput {
type ListNamespacesInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that contains the QuickSight namespaces that you
- // want to list.
+ // The ID for the Amazon Web Services account; that contains the QuickSight
+ // namespaces that you want to list.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26695,15 +27467,15 @@ func (s *ListNamespacesInput) SetNextToken(v string) *ListNamespacesInput {
type ListNamespacesOutput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
Namespaces []*NamespaceInfoV2 `type:"list"`
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26789,7 +27561,7 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource
type ListTagsForResourceOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26831,8 +27603,8 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
type ListTemplateAliasesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the template aliases that you're
- // listing.
+ // The ID of the Amazon Web Services account; that contains the template aliases
+ // that you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -26914,7 +27686,7 @@ type ListTemplateAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -26961,7 +27733,8 @@ func (s *ListTemplateAliasesOutput) SetTemplateAliasList(v []*TemplateAlias) *Li
type ListTemplateVersionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the templates that you're listing.
+ // The ID of the Amazon Web Services account; that contains the templates that
+ // you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27043,7 +27816,7 @@ type ListTemplateVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27090,7 +27863,8 @@ func (s *ListTemplateVersionsOutput) SetTemplateVersionSummaryList(v []*Template
type ListTemplatesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the templates that you're listing.
+ // The ID of the Amazon Web Services account; that contains the templates that
+ // you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27155,7 +27929,7 @@ type ListTemplatesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27202,7 +27976,8 @@ func (s *ListTemplatesOutput) SetTemplateSummaryList(v []*TemplateSummary) *List
type ListThemeAliasesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the theme aliases that you're listing.
+ // The ID of the Amazon Web Services account; that contains the theme aliases
+ // that you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27284,7 +28059,7 @@ type ListThemeAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27331,7 +28106,8 @@ func (s *ListThemeAliasesOutput) SetThemeAliasList(v []*ThemeAlias) *ListThemeAl
type ListThemeVersionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the themes that you're listing.
+ // The ID of the Amazon Web Services account; that contains the themes that
+ // you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27413,7 +28189,7 @@ type ListThemeVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27460,7 +28236,8 @@ func (s *ListThemeVersionsOutput) SetThemeVersionSummaryList(v []*ThemeVersionSu
type ListThemesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the themes that you're listing.
+ // The ID of the Amazon Web Services account; that contains the themes that
+ // you're listing.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27477,7 +28254,7 @@ type ListThemesInput struct {
//
// * CUSTOM - Display only the themes created by people using Amazon QuickSight.
//
- // * QUICKSIGHT - Display only the starting themes defined by QuickSight.
+ // * QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.
Type *string `location:"querystring" locationName:"type" type:"string" enum:"ThemeType"`
}
@@ -27540,7 +28317,7 @@ type ListThemesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27587,8 +28364,9 @@ func (s *ListThemesOutput) SetThemeSummaryList(v []*ThemeSummary) *ListThemesOut
type ListUserGroupsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID that the user is in. Currently, you use the ID for the
- // AWS account that contains your Amazon QuickSight account.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27690,7 +28468,7 @@ type ListUserGroupsOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -27734,8 +28512,9 @@ func (s *ListUserGroupsOutput) SetStatus(v int64) *ListUserGroupsOutput {
type ListUsersInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -27817,7 +28596,7 @@ type ListUsersOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -28308,7 +29087,7 @@ type NamespaceInfoV2 struct {
// The namespace ARN.
Arn *string `type:"string"`
- // The namespace AWS Region.
+ // The namespace Region;.
CapacityRegion *string `type:"string"`
// The creation status of a namespace that is not yet completely created.
@@ -28741,7 +29520,7 @@ type PreconditionNotMetException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -29086,8 +29865,9 @@ func (s *RedshiftParameters) SetPort(v int64) *RedshiftParameters {
type RegisterUserInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -29121,8 +29901,7 @@ type RegisterUserInput struct {
// 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).
+ // This feature is available only to QuickSight Enterprise edition subscriptions.
CustomPermissionsName *string `min:"1" type:"string"`
// The email address of the user that you want to register.
@@ -29323,7 +30102,7 @@ func (s *RegisterUserInput) SetUserRole(v string) *RegisterUserInput {
type RegisterUserOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -29371,6 +30150,186 @@ func (s *RegisterUserOutput) SetUserInvitationUrl(v string) *RegisterUserOutput
return s
}
+// Information about the dashboard you want to embed.
+type RegisteredUserDashboardEmbeddingConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ //
+ // InitialDashboardId is a required field
+ InitialDashboardId *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s RegisteredUserDashboardEmbeddingConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RegisteredUserDashboardEmbeddingConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RegisteredUserDashboardEmbeddingConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RegisteredUserDashboardEmbeddingConfiguration"}
+ if s.InitialDashboardId == nil {
+ invalidParams.Add(request.NewErrParamRequired("InitialDashboardId"))
+ }
+ if s.InitialDashboardId != nil && len(*s.InitialDashboardId) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("InitialDashboardId", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetInitialDashboardId sets the InitialDashboardId field's value.
+func (s *RegisteredUserDashboardEmbeddingConfiguration) SetInitialDashboardId(v string) *RegisteredUserDashboardEmbeddingConfiguration {
+ s.InitialDashboardId = &v
+ return s
+}
+
+// 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.
+type RegisteredUserEmbeddingExperienceConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // The configuration details for providing a dashboard embedding experience.
+ Dashboard *RegisteredUserDashboardEmbeddingConfiguration `type:"structure"`
+
+ // 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 (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
+ // 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:
+ //
+ // * Embedding the Full Functionality of the Amazon QuickSight Console for
+ // Authenticated Users (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html)
+ //
+ // * Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
+ //
+ // 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 (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).
+ QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration `type:"structure"`
+}
+
+// String returns the string representation
+func (s RegisteredUserEmbeddingExperienceConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RegisteredUserEmbeddingExperienceConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RegisteredUserEmbeddingExperienceConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RegisteredUserEmbeddingExperienceConfiguration"}
+ if s.Dashboard != nil {
+ if err := s.Dashboard.Validate(); err != nil {
+ invalidParams.AddNested("Dashboard", err.(request.ErrInvalidParams))
+ }
+ }
+ if s.QuickSightConsole != nil {
+ if err := s.QuickSightConsole.Validate(); err != nil {
+ invalidParams.AddNested("QuickSightConsole", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetDashboard sets the Dashboard field's value.
+func (s *RegisteredUserEmbeddingExperienceConfiguration) SetDashboard(v *RegisteredUserDashboardEmbeddingConfiguration) *RegisteredUserEmbeddingExperienceConfiguration {
+ s.Dashboard = v
+ return s
+}
+
+// SetQuickSightConsole sets the QuickSightConsole field's value.
+func (s *RegisteredUserEmbeddingExperienceConfiguration) SetQuickSightConsole(v *RegisteredUserQuickSightConsoleEmbeddingConfiguration) *RegisteredUserEmbeddingExperienceConfiguration {
+ s.QuickSightConsole = v
+ return s
+}
+
+// Information about the Amazon QuickSight console that you want to embed.
+type RegisteredUserQuickSightConsoleEmbeddingConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ InitialPath *string `min:"1" type:"string"`
+}
+
+// String returns the string representation
+func (s RegisteredUserQuickSightConsoleEmbeddingConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RegisteredUserQuickSightConsoleEmbeddingConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RegisteredUserQuickSightConsoleEmbeddingConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RegisteredUserQuickSightConsoleEmbeddingConfiguration"}
+ if s.InitialPath != nil && len(*s.InitialPath) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("InitialPath", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetInitialPath sets the InitialPath field's value.
+func (s *RegisteredUserQuickSightConsoleEmbeddingConfiguration) SetInitialPath(v string) *RegisteredUserQuickSightConsoleEmbeddingConfiguration {
+ s.InitialPath = &v
+ return s
+}
+
// A physical table type for relational data sources.
type RelationalTable struct {
_ struct{} `type:"structure"`
@@ -29538,7 +30497,7 @@ type ResourceExistsException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
// The resource type for this request.
@@ -29600,7 +30559,7 @@ type ResourceNotFoundException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
// The resource type for this request.
@@ -29672,9 +30631,9 @@ type ResourcePermission struct {
// * 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 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.)
//
// Principal is a required field
Principal *string `min:"1" type:"string" required:"true"`
@@ -29731,7 +30690,7 @@ type ResourceUnavailableException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
// The resource type for this request.
@@ -29794,7 +30753,7 @@ type RestoreAnalysisInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the analysis.
+ // The ID of the Amazon Web Services account; that contains the analysis.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -29853,7 +30812,7 @@ type RestoreAnalysisOutput struct {
// The Amazon Resource Name (ARN) of the analysis that you're restoring.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -29959,6 +30918,10 @@ type RowLevelPermissionDataSet struct {
//
// PermissionPolicy is a required field
PermissionPolicy *string `type:"string" required:"true" enum:"RowLevelPermissionPolicy"`
+
+ // The status of the row-level security permission dataset. If enabled, the
+ // status is ENABLED. If disabled, the status is DISABLED.
+ Status *string `type:"string" enum:"Status"`
}
// String returns the string representation
@@ -30011,12 +30974,161 @@ func (s *RowLevelPermissionDataSet) SetPermissionPolicy(v string) *RowLevelPermi
return s
}
+// SetStatus sets the Status field's value.
+func (s *RowLevelPermissionDataSet) SetStatus(v string) *RowLevelPermissionDataSet {
+ s.Status = &v
+ return s
+}
+
+// The configuration of tags on a dataset to set row-level security.
+type RowLevelPermissionTagConfiguration struct {
+ _ struct{} `type:"structure"`
+
+ // The status of row-level security tags. If enabled, the status is ENABLED.
+ // If disabled, the status is DISABLED.
+ Status *string `type:"string" enum:"Status"`
+
+ // A set of rules associated with row-level security, such as the tag names
+ // and columns that they are assigned to.
+ //
+ // TagRules is a required field
+ TagRules []*RowLevelPermissionTagRule `min:"1" type:"list" required:"true"`
+}
+
+// String returns the string representation
+func (s RowLevelPermissionTagConfiguration) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RowLevelPermissionTagConfiguration) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RowLevelPermissionTagConfiguration) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RowLevelPermissionTagConfiguration"}
+ if s.TagRules == nil {
+ invalidParams.Add(request.NewErrParamRequired("TagRules"))
+ }
+ if s.TagRules != nil && len(s.TagRules) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("TagRules", 1))
+ }
+ if s.TagRules != nil {
+ for i, v := range s.TagRules {
+ if v == nil {
+ continue
+ }
+ if err := v.Validate(); err != nil {
+ invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TagRules", i), err.(request.ErrInvalidParams))
+ }
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetStatus sets the Status field's value.
+func (s *RowLevelPermissionTagConfiguration) SetStatus(v string) *RowLevelPermissionTagConfiguration {
+ s.Status = &v
+ return s
+}
+
+// SetTagRules sets the TagRules field's value.
+func (s *RowLevelPermissionTagConfiguration) SetTagRules(v []*RowLevelPermissionTagRule) *RowLevelPermissionTagConfiguration {
+ s.TagRules = v
+ return s
+}
+
+// A set of rules associated with a tag.
+type RowLevelPermissionTagRule struct {
+ _ struct{} `type:"structure"`
+
+ // The column name that a tag key is assigned to.
+ //
+ // ColumnName is a required field
+ ColumnName *string `type:"string" required:"true"`
+
+ // 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.
+ MatchAllValue *string `min:"1" type:"string" sensitive:"true"`
+
+ // The unique key for a tag.
+ //
+ // TagKey is a required field
+ TagKey *string `min:"1" type:"string" required:"true"`
+
+ // 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.
+ TagMultiValueDelimiter *string `type:"string"`
+}
+
+// String returns the string representation
+func (s RowLevelPermissionTagRule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RowLevelPermissionTagRule) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RowLevelPermissionTagRule) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RowLevelPermissionTagRule"}
+ if s.ColumnName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ColumnName"))
+ }
+ if s.MatchAllValue != nil && len(*s.MatchAllValue) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("MatchAllValue", 1))
+ }
+ if s.TagKey == nil {
+ invalidParams.Add(request.NewErrParamRequired("TagKey"))
+ }
+ if s.TagKey != nil && len(*s.TagKey) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("TagKey", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetColumnName sets the ColumnName field's value.
+func (s *RowLevelPermissionTagRule) SetColumnName(v string) *RowLevelPermissionTagRule {
+ s.ColumnName = &v
+ return s
+}
+
+// SetMatchAllValue sets the MatchAllValue field's value.
+func (s *RowLevelPermissionTagRule) SetMatchAllValue(v string) *RowLevelPermissionTagRule {
+ s.MatchAllValue = &v
+ return s
+}
+
+// SetTagKey sets the TagKey field's value.
+func (s *RowLevelPermissionTagRule) SetTagKey(v string) *RowLevelPermissionTagRule {
+ s.TagKey = &v
+ return s
+}
+
+// SetTagMultiValueDelimiter sets the TagMultiValueDelimiter field's value.
+func (s *RowLevelPermissionTagRule) SetTagMultiValueDelimiter(v string) *RowLevelPermissionTagRule {
+ s.TagMultiValueDelimiter = &v
+ return s
+}
+
// S3 parameters.
type S3Parameters struct {
_ struct{} `type:"structure"`
// Location of the Amazon S3 manifest file. This is NULL if the manifest file
- // was uploaded in the console.
+ // was uploaded into QuickSight.
//
// ManifestFileLocation is a required field
ManifestFileLocation *ManifestFileLocation `type:"structure" required:"true"`
@@ -30141,8 +31253,8 @@ func (s *S3Source) SetUploadSettings(v *UploadSettings) *S3Source {
type SearchAnalysesInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the analyses that you're searching
- // for.
+ // The ID of the Amazon Web Services account; that contains the analyses that
+ // you're searching for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -30227,7 +31339,7 @@ type SearchAnalysesOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -30271,8 +31383,8 @@ func (s *SearchAnalysesOutput) SetStatus(v int64) *SearchAnalysesOutput {
type SearchDashboardsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the user whose dashboards you're
- // searching for.
+ // The ID of the Amazon Web Services account; that contains the user whose dashboards
+ // you're searching for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -30370,7 +31482,7 @@ type SearchDashboardsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -30591,7 +31703,7 @@ type SessionLifetimeInMinutesInvalidException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -30643,11 +31755,70 @@ func (s *SessionLifetimeInMinutesInvalidException) RequestID() string {
return s.RespMetadata.RequestID
}
+// The key-value pair used for the row-level security tags feature.
+type SessionTag struct {
+ _ struct{} `type:"structure"`
+
+ // The key for the tag.
+ //
+ // Key is a required field
+ Key *string `min:"1" type:"string" required:"true"`
+
+ // The value that you want to assign the tag.
+ //
+ // Value is a required field
+ Value *string `min:"1" type:"string" required:"true" sensitive:"true"`
+}
+
+// String returns the string representation
+func (s SessionTag) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s SessionTag) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *SessionTag) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "SessionTag"}
+ if s.Key == nil {
+ invalidParams.Add(request.NewErrParamRequired("Key"))
+ }
+ if s.Key != nil && len(*s.Key) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Key", 1))
+ }
+ if s.Value == nil {
+ invalidParams.Add(request.NewErrParamRequired("Value"))
+ }
+ if s.Value != nil && len(*s.Value) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Value", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetKey sets the Key field's value.
+func (s *SessionTag) SetKey(v string) *SessionTag {
+ s.Key = &v
+ return s
+}
+
+// SetValue sets the Value field's value.
+func (s *SessionTag) SetValue(v string) *SessionTag {
+ s.Value = &v
+ return s
+}
+
// 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.
+// 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.
type Sheet struct {
_ struct{} `type:"structure"`
@@ -31093,9 +32264,9 @@ type TagColumnOperation struct {
// ColumnName is a required field
ColumnName *string `min:"1" type:"string" required:"true"`
- // The dataset column tag, currently only used for geospatial type tagging. .
+ // The dataset column tag, currently only used for geospatial type tagging.
//
- // This is not tags for the AWS tagging feature. .
+ // This is not tags for the Amazon Web Services tagging feature.
//
// Tags is a required field
Tags []*ColumnTag `min:"1" type:"list" required:"true"`
@@ -31217,7 +32388,7 @@ func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput {
type TagResourceOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -31253,8 +32424,9 @@ func (s *TagResourceOutput) SetStatus(v int64) *TagResourceOutput {
// 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.
+// 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.
type Template struct {
_ struct{} `type:"structure"`
@@ -31270,7 +32442,8 @@ type Template struct {
// The display name of the template.
Name *string `min:"1" type:"string"`
- // The ID for the template. This is unique per AWS Region for each AWS account.
+ // The ID for the template. This is unique per Region; for each Amazon Web Services
+ // account;.
TemplateId *string `min:"1" type:"string"`
// A structure describing the versions of the template.
@@ -31576,7 +32749,8 @@ type TemplateSummary struct {
// A display name for the template.
Name *string `min:"1" type:"string"`
- // The ID of the template. This ID is unique per AWS Region for each AWS account.
+ // The ID of the template. This ID is unique per Region; for each Amazon Web
+ // Services account;.
TemplateId *string `min:"1" type:"string"`
}
@@ -32079,7 +33253,8 @@ type ThemeSummary struct {
// the display name for the theme.
Name *string `min:"1" type:"string"`
- // The ID of the theme. This ID is unique per AWS Region for each AWS account.
+ // The ID of the theme. This ID is unique per Region; for each Amazon Web Services
+ // account;.
ThemeId *string `min:"1" type:"string"`
}
@@ -32284,7 +33459,7 @@ type ThrottlingException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -32738,10 +33913,10 @@ func (s *UIColorPalette) SetWarningForeground(v string) *UIColorPalette {
}
// 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.
+// 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.
@@ -32751,7 +33926,7 @@ type UnsupportedPricingPlanException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -32813,7 +33988,7 @@ type UnsupportedUserEditionException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -32927,7 +34102,7 @@ func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput {
type UntagResourceOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -32959,13 +34134,13 @@ func (s *UntagResourceOutput) SetStatus(v int64) *UntagResourceOutput {
type UpdateAccountCustomizationInput struct {
_ struct{} `type:"structure"`
- // The QuickSight customizations you're updating in the current AWS Region.
+ // The QuickSight customizations you're updating in the current Region;.
//
// AccountCustomization is a required field
AccountCustomization *AccountCustomization `type:"structure" required:"true"`
- // The ID for the AWS account that you want to update QuickSight customizations
- // for.
+ // The ID for the Amazon Web Services account; that you want to update QuickSight
+ // customizations for.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -33024,21 +34199,21 @@ func (s *UpdateAccountCustomizationInput) SetNamespace(v string) *UpdateAccountC
type UpdateAccountCustomizationOutput struct {
_ struct{} `type:"structure"`
- // The QuickSight customizations you're updating in the current AWS Region.
+ // The QuickSight customizations you're updating in the current Region;.
AccountCustomization *AccountCustomization `type:"structure"`
- // The Amazon Resource Name (ARN) for the updated customization for this AWS
- // account.
+ // The Amazon Resource Name (ARN) for the updated customization for this Amazon
+ // Web Services account;.
Arn *string `type:"string"`
- // The ID for the AWS account that you want to update QuickSight customizations
- // for.
+ // The ID for the Amazon Web Services account; that you want to update QuickSight
+ // customizations for.
AwsAccountId *string `min:"12" type:"string"`
// The namespace associated with the customization that you're updating.
Namespace *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33094,22 +34269,22 @@ func (s *UpdateAccountCustomizationOutput) SetStatus(v int64) *UpdateAccountCust
type UpdateAccountSettingsInput struct {
_ struct{} `type:"structure"`
- // The ID for the AWS account that contains the QuickSight settings that you
- // want to list.
+ // The ID for the Amazon Web Services account; that contains the QuickSight
+ // settings that you want to list.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // 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.
//
// DefaultNamespace is a required field
DefaultNamespace *string `type:"string" required:"true"`
// The email address that you want QuickSight to send notifications to regarding
- // your AWS account or QuickSight subscription.
+ // your Amazon Web Services account; or QuickSight subscription.
NotificationEmail *string `type:"string"`
}
@@ -33163,7 +34338,7 @@ func (s *UpdateAccountSettingsInput) SetNotificationEmail(v string) *UpdateAccou
type UpdateAccountSettingsOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33201,7 +34376,8 @@ type UpdateAnalysisInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the analysis that you're updating.
+ // The ID of the Amazon Web Services account; that contains the analysis that
+ // you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -33325,7 +34501,7 @@ type UpdateAnalysisOutput struct {
// The ARN of the analysis that you're updating.
Arn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33384,8 +34560,9 @@ type UpdateAnalysisPermissionsInput struct {
// AnalysisId is a required field
AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -33488,7 +34665,7 @@ type UpdateAnalysisPermissionsOutput struct {
// on an analysis.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33538,7 +34715,8 @@ func (s *UpdateAnalysisPermissionsOutput) SetStatus(v int64) *UpdateAnalysisPerm
type UpdateDashboardInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard that you're updating.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -33579,8 +34757,8 @@ type UpdateDashboardInput struct {
// 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.
+ // 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
@@ -33591,8 +34769,8 @@ type UpdateDashboardInput struct {
// 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.
+ // associated with the entity. The theme ARN must exist in the same Amazon Web
+ // Services account; where you create the dashboard.
ThemeArn *string `type:"string"`
// A description for the first version of the dashboard being created.
@@ -33713,7 +34891,7 @@ type UpdateDashboardOutput struct {
// The ID for the dashboard.
DashboardId *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33772,8 +34950,8 @@ func (s *UpdateDashboardOutput) SetVersionArn(v string) *UpdateDashboardOutput {
type UpdateDashboardPermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard whose permissions you're
- // updating.
+ // The ID of the Amazon Web Services account; that contains the dashboard whose
+ // permissions you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -33878,7 +35056,7 @@ type UpdateDashboardPermissionsOutput struct {
// Information about the permissions on the dashboard.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -33928,7 +35106,8 @@ func (s *UpdateDashboardPermissionsOutput) SetStatus(v int64) *UpdateDashboardPe
type UpdateDashboardPublishedVersionInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the dashboard that you're updating.
+ // The ID of the Amazon Web Services account; that contains the dashboard that
+ // you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -34009,7 +35188,7 @@ type UpdateDashboardPublishedVersionOutput struct {
// The ID for the dashboard.
DashboardId *string `min:"1" type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -34053,7 +35232,7 @@ func (s *UpdateDashboardPublishedVersionOutput) SetStatus(v int64) *UpdateDashbo
type UpdateDataSetInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -34065,8 +35244,8 @@ type UpdateDataSetInput struct {
// A set of one or more definitions of a ColumnLevelPermissionRule .
ColumnLevelPermissionRules []*ColumnLevelPermissionRule `min:"1" type:"list"`
- // The ID for the dataset that you want to update. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to update. This ID is unique per Region;
+ // for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `location:"uri" locationName:"DataSetId" type:"string" required:"true"`
@@ -34095,6 +35274,10 @@ type UpdateDataSetInput struct {
// The row-level security configuration for the data you want to create.
RowLevelPermissionDataSet *RowLevelPermissionDataSet `type:"structure"`
+
+ // The configuration of tags on a dataset to set row-level security. Row-level
+ // security tags are currently supported for anonymous embedding only.
+ RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration `type:"structure"`
}
// String returns the string representation
@@ -34191,6 +35374,11 @@ func (s *UpdateDataSetInput) Validate() error {
invalidParams.AddNested("RowLevelPermissionDataSet", err.(request.ErrInvalidParams))
}
}
+ if s.RowLevelPermissionTagConfiguration != nil {
+ if err := s.RowLevelPermissionTagConfiguration.Validate(); err != nil {
+ invalidParams.AddNested("RowLevelPermissionTagConfiguration", err.(request.ErrInvalidParams))
+ }
+ }
if invalidParams.Len() > 0 {
return invalidParams
@@ -34258,14 +35446,20 @@ func (s *UpdateDataSetInput) SetRowLevelPermissionDataSet(v *RowLevelPermissionD
return s
}
+// SetRowLevelPermissionTagConfiguration sets the RowLevelPermissionTagConfiguration field's value.
+func (s *UpdateDataSetInput) SetRowLevelPermissionTagConfiguration(v *RowLevelPermissionTagConfiguration) *UpdateDataSetInput {
+ s.RowLevelPermissionTagConfiguration = v
+ return s
+}
+
type UpdateDataSetOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the dataset.
Arn *string `type:"string"`
- // The ID for the dataset that you want to create. This ID is unique per AWS
- // Region for each AWS account.
+ // The ID for the dataset that you want to create. This ID is unique per Region;
+ // for each Amazon Web Services account;.
DataSetId *string `type:"string"`
// The ARN for the ingestion, which is triggered as a result of dataset creation
@@ -34276,7 +35470,7 @@ type UpdateDataSetOutput struct {
// if the import mode is SPICE.
IngestionId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -34332,13 +35526,13 @@ func (s *UpdateDataSetOutput) SetStatus(v int64) *UpdateDataSetOutput {
type UpdateDataSetPermissionsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
// The ID for the dataset whose permissions you want to update. This ID is unique
- // per AWS Region for each AWS account.
+ // per Region; for each Amazon Web Services account;.
//
// DataSetId is a required field
DataSetId *string `location:"uri" locationName:"DataSetId" type:"string" required:"true"`
@@ -34439,10 +35633,10 @@ type UpdateDataSetPermissionsOutput struct {
DataSetArn *string `type:"string"`
// The ID for the dataset whose permissions you want to update. This ID is unique
- // per AWS Region for each AWS account.
+ // per Region; for each Amazon Web Services account;.
DataSetId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -34486,7 +35680,7 @@ func (s *UpdateDataSetPermissionsOutput) SetStatus(v int64) *UpdateDataSetPermis
type UpdateDataSourceInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -34495,8 +35689,8 @@ type UpdateDataSourceInput struct {
// Currently, only credentials based on user name and password are supported.
Credentials *DataSourceCredentials `type:"structure" sensitive:"true"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `location:"uri" locationName:"DataSourceId" type:"string" required:"true"`
@@ -34619,11 +35813,11 @@ type UpdateDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source.
Arn *string `type:"string"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -34676,13 +35870,13 @@ func (s *UpdateDataSourceOutput) SetUpdateStatus(v string) *UpdateDataSourceOutp
type UpdateDataSourcePermissionsInput struct {
_ struct{} `type:"structure"`
- // The AWS account ID.
+ // The Amazon Web Services account; ID.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
//
// DataSourceId is a required field
DataSourceId *string `location:"uri" locationName:"DataSourceId" type:"string" required:"true"`
@@ -34782,11 +35976,11 @@ type UpdateDataSourcePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the data source.
DataSourceArn *string `type:"string"`
- // The ID of the data source. This ID is unique per AWS Region for each AWS
- // account.
+ // The ID of the data source. This ID is unique per Region; for each Amazon
+ // Web Services account;.
DataSourceId *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35116,8 +36310,9 @@ func (s *UpdateFolderPermissionsOutput) SetStatus(v int64) *UpdateFolderPermissi
type UpdateGroupInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -35207,7 +36402,7 @@ type UpdateGroupOutput struct {
// The name of the group.
Group *Group `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35246,7 +36441,7 @@ type UpdateIAMPolicyAssignmentInput struct {
_ struct{} `type:"structure"`
// The name of the assignment, also called a rule. This name must be unique
- // within an AWS account.
+ // within an Amazon Web Services account;.
//
// AssignmentName is a required field
AssignmentName *string `location:"uri" locationName:"AssignmentName" min:"1" type:"string" required:"true"`
@@ -35262,7 +36457,7 @@ type UpdateIAMPolicyAssignmentInput struct {
// the data source.
AssignmentStatus *string `type:"string" enum:"AssignmentStatus"`
- // The ID of the AWS account that contains the IAM policy assignment.
+ // The ID of the Amazon Web Services account; that contains the IAM policy assignment.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -35382,7 +36577,7 @@ type UpdateIAMPolicyAssignmentOutput struct {
// in this assignment.
PolicyArn *string `type:"string"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35452,7 +36647,8 @@ type UpdateTemplateAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the template alias that you're updating.
+ // The ID of the Amazon Web Services account; that contains the template alias
+ // that you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -35539,7 +36735,7 @@ func (s *UpdateTemplateAliasInput) SetTemplateVersionNumber(v int64) *UpdateTemp
type UpdateTemplateAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35580,7 +36776,8 @@ func (s *UpdateTemplateAliasOutput) SetTemplateAlias(v *TemplateAlias) *UpdateTe
type UpdateTemplateInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the template that you're updating.
+ // The ID of the Amazon Web Services account; that contains the template that
+ // you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -35593,8 +36790,8 @@ type UpdateTemplateInput struct {
// 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.
+ // 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.
@@ -35700,7 +36897,7 @@ type UpdateTemplateOutput struct {
// The creation status of the template.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35763,7 +36960,7 @@ func (s *UpdateTemplateOutput) SetVersionArn(v string) *UpdateTemplateOutput {
type UpdateTemplatePermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the template.
+ // The ID of the Amazon Web Services account; that contains the template.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -35862,7 +37059,7 @@ type UpdateTemplatePermissionsOutput struct {
// A list of resource permissions to be set on the template.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -35923,7 +37120,8 @@ type UpdateThemeAliasInput struct {
// AliasName is a required field
AliasName *string `location:"uri" locationName:"AliasName" min:"1" type:"string" required:"true"`
- // The ID of the AWS account that contains the theme alias that you're updating.
+ // The ID of the Amazon Web Services account; that contains the theme alias
+ // that you're updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -36010,7 +37208,7 @@ func (s *UpdateThemeAliasInput) SetThemeVersionNumber(v int64) *UpdateThemeAlias
type UpdateThemeAliasOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -36051,13 +37249,14 @@ func (s *UpdateThemeAliasOutput) SetThemeAlias(v *ThemeAlias) *UpdateThemeAliasO
type UpdateThemeInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the theme that you're updating.
+ // The ID of the Amazon Web Services account; that contains the theme that you're
+ // updating.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
// The theme ID, defined by Amazon QuickSight, that a custom theme inherits
- // from. All themes initially inherit from a default QuickSight theme.
+ // from. All themes initially inherit from a default Amazon QuickSight theme.
//
// BaseThemeId is a required field
BaseThemeId *string `min:"1" type:"string" required:"true"`
@@ -36168,7 +37367,7 @@ type UpdateThemeOutput struct {
// The creation status of the theme.
CreationStatus *string `type:"string" enum:"ResourceStatus"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -36230,7 +37429,7 @@ func (s *UpdateThemeOutput) SetVersionArn(v string) *UpdateThemeOutput {
type UpdateThemePermissionsInput struct {
_ struct{} `type:"structure"`
- // The ID of the AWS account that contains the theme.
+ // The ID of the Amazon Web Services account; that contains the theme.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -36329,7 +37528,7 @@ type UpdateThemePermissionsOutput struct {
// The resulting list of resource permissions for the theme.
Permissions []*ResourcePermission `min:"1" type:"list"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -36385,8 +37584,9 @@ func (s *UpdateThemePermissionsOutput) SetThemeId(v string) *UpdateThemePermissi
type UpdateUserInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
//
// AwsAccountId is a required field
AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`
@@ -36418,8 +37618,7 @@ type UpdateUserInput struct {
// 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).
+ // This feature is available only to QuickSight Enterprise edition subscriptions.
CustomPermissionsName *string `min:"1" type:"string"`
// The email address of the user that you want to update.
@@ -36591,7 +37790,7 @@ func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput {
type UpdateUserOutput struct {
_ struct{} `type:"structure"`
- // The AWS request ID for this operation.
+ // The Amazon Web Services request ID for this operation.
RequestId *string `type:"string"`
// The HTTP status of the request.
@@ -36849,7 +38048,7 @@ type UserNotFoundException struct {
Message_ *string `locationName:"Message" type:"string"`
- // The AWS request ID for this request.
+ // The Amazon Web Services request ID for this request.
RequestId *string `type:"string"`
}
@@ -37948,6 +39147,22 @@ func RowLevelPermissionPolicy_Values() []string {
}
}
+const (
+ // StatusEnabled is a Status enum value
+ StatusEnabled = "ENABLED"
+
+ // StatusDisabled is a Status enum value
+ StatusDisabled = "DISABLED"
+)
+
+// Status_Values returns all elements of the Status enum
+func Status_Values() []string {
+ return []string{
+ StatusEnabled,
+ StatusDisabled,
+ }
+}
+
const (
// TemplateErrorTypeSourceNotFound is a TemplateErrorType enum value
TemplateErrorTypeSourceNotFound = "SOURCE_NOT_FOUND"
diff --git a/service/quicksight/doc.go b/service/quicksight/doc.go
index 34e16d1c11..28ae34eff6 100644
--- a/service/quicksight/doc.go
+++ b/service/quicksight/doc.go
@@ -4,9 +4,9 @@
// requests to Amazon QuickSight.
//
// 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.
+// 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.
//
// See https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01 for more information on this service.
//
diff --git a/service/quicksight/errors.go b/service/quicksight/errors.go
index 1b972231ea..05a7b3db6a 100644
--- a/service/quicksight/errors.go
+++ b/service/quicksight/errors.go
@@ -110,10 +110,10 @@ const (
// "UnsupportedPricingPlanException".
//
// 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.
+ // 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.
diff --git a/service/quicksight/quicksightiface/interface.go b/service/quicksight/quicksightiface/interface.go
index 9dd496de12..cf7c1d891c 100644
--- a/service/quicksight/quicksightiface/interface.go
+++ b/service/quicksight/quicksightiface/interface.go
@@ -292,6 +292,14 @@ type QuickSightAPI interface {
DescribeUserWithContext(aws.Context, *quicksight.DescribeUserInput, ...request.Option) (*quicksight.DescribeUserOutput, error)
DescribeUserRequest(*quicksight.DescribeUserInput) (*request.Request, *quicksight.DescribeUserOutput)
+ GenerateEmbedUrlForAnonymousUser(*quicksight.GenerateEmbedUrlForAnonymousUserInput) (*quicksight.GenerateEmbedUrlForAnonymousUserOutput, error)
+ GenerateEmbedUrlForAnonymousUserWithContext(aws.Context, *quicksight.GenerateEmbedUrlForAnonymousUserInput, ...request.Option) (*quicksight.GenerateEmbedUrlForAnonymousUserOutput, error)
+ GenerateEmbedUrlForAnonymousUserRequest(*quicksight.GenerateEmbedUrlForAnonymousUserInput) (*request.Request, *quicksight.GenerateEmbedUrlForAnonymousUserOutput)
+
+ GenerateEmbedUrlForRegisteredUser(*quicksight.GenerateEmbedUrlForRegisteredUserInput) (*quicksight.GenerateEmbedUrlForRegisteredUserOutput, error)
+ GenerateEmbedUrlForRegisteredUserWithContext(aws.Context, *quicksight.GenerateEmbedUrlForRegisteredUserInput, ...request.Option) (*quicksight.GenerateEmbedUrlForRegisteredUserOutput, error)
+ GenerateEmbedUrlForRegisteredUserRequest(*quicksight.GenerateEmbedUrlForRegisteredUserInput) (*request.Request, *quicksight.GenerateEmbedUrlForRegisteredUserOutput)
+
GetDashboardEmbedUrl(*quicksight.GetDashboardEmbedUrlInput) (*quicksight.GetDashboardEmbedUrlOutput, error)
GetDashboardEmbedUrlWithContext(aws.Context, *quicksight.GetDashboardEmbedUrlInput, ...request.Option) (*quicksight.GetDashboardEmbedUrlOutput, error)
GetDashboardEmbedUrlRequest(*quicksight.GetDashboardEmbedUrlInput) (*request.Request, *quicksight.GetDashboardEmbedUrlOutput)
diff --git a/service/redshiftdataapiservice/api.go b/service/redshiftdataapiservice/api.go
index 8a350ae840..48f34b500f 100644
--- a/service/redshiftdataapiservice/api.go
+++ b/service/redshiftdataapiservice/api.go
@@ -12,6 +12,101 @@ import (
"github.com/aws/aws-sdk-go/private/protocol"
)
+const opBatchExecuteStatement = "BatchExecuteStatement"
+
+// BatchExecuteStatementRequest generates a "aws/request.Request" representing the
+// client's request for the BatchExecuteStatement operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See BatchExecuteStatement for more information on using the BatchExecuteStatement
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the BatchExecuteStatementRequest method.
+// req, resp := client.BatchExecuteStatementRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement
+func (c *RedshiftDataAPIService) BatchExecuteStatementRequest(input *BatchExecuteStatementInput) (req *request.Request, output *BatchExecuteStatementOutput) {
+ op := &request.Operation{
+ Name: opBatchExecuteStatement,
+ HTTPMethod: "POST",
+ HTTPPath: "/",
+ }
+
+ if input == nil {
+ input = &BatchExecuteStatementInput{}
+ }
+
+ output = &BatchExecuteStatementOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// BatchExecuteStatement API operation for Redshift Data API Service.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Redshift Data API Service's
+// API operation BatchExecuteStatement for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// The Amazon Redshift Data API operation failed due to invalid input.
+//
+// * ActiveStatementsExceededException
+// The number of active statements exceeds the limit.
+//
+// * BatchExecuteStatementException
+// An SQL statement encountered an environmental error while running.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement
+func (c *RedshiftDataAPIService) BatchExecuteStatement(input *BatchExecuteStatementInput) (*BatchExecuteStatementOutput, error) {
+ req, out := c.BatchExecuteStatementRequest(input)
+ return out, req.Send()
+}
+
+// BatchExecuteStatementWithContext is the same as BatchExecuteStatement with the addition of
+// the ability to pass a context and additional request options.
+//
+// See BatchExecuteStatement for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *RedshiftDataAPIService) BatchExecuteStatementWithContext(ctx aws.Context, input *BatchExecuteStatementInput, opts ...request.Option) (*BatchExecuteStatementOutput, error) {
+ req, out := c.BatchExecuteStatementRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
const opCancelStatement = "CancelStatement"
// CancelStatementRequest generates a "aws/request.Request" representing the
@@ -66,6 +161,9 @@ func (c *RedshiftDataAPIService) CancelStatementRequest(input *CancelStatementIn
// API operation CancelStatement for usage and error information.
//
// Returned Error Types:
+// * ValidationException
+// The Amazon Redshift Data API operation failed due to invalid input.
+//
// * ResourceNotFoundException
// The Amazon Redshift Data API operation failed due to a missing resource.
//
@@ -237,8 +335,9 @@ func (c *RedshiftDataAPIService) DescribeTableRequest(input *DescribeTableInput)
// 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.
+// * 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
@@ -381,8 +480,9 @@ func (c *RedshiftDataAPIService) ExecuteStatementRequest(input *ExecuteStatement
// 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.
+// * 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
@@ -625,8 +725,9 @@ func (c *RedshiftDataAPIService) ListDatabasesRequest(input *ListDatabasesInput)
// 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.
+// * 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
@@ -774,8 +875,9 @@ func (c *RedshiftDataAPIService) ListSchemasRequest(input *ListSchemasInput) (re
// 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.
+// * 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
@@ -1065,8 +1167,9 @@ func (c *RedshiftDataAPIService) ListTablesRequest(input *ListTablesInput) (req
// 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.
+// * 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
@@ -1216,12 +1319,254 @@ func (s *ActiveStatementsExceededException) RequestID() string {
return s.RespMetadata.RequestID
}
+// An SQL statement encountered an environmental error while running.
+type BatchExecuteStatementException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"Message" type:"string"`
+
+ // Statement identifier of the exception.
+ //
+ // StatementId is a required field
+ StatementId *string `type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s BatchExecuteStatementException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s BatchExecuteStatementException) GoString() string {
+ return s.String()
+}
+
+func newErrorBatchExecuteStatementException(v protocol.ResponseMetadata) error {
+ return &BatchExecuteStatementException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *BatchExecuteStatementException) Code() string {
+ return "BatchExecuteStatementException"
+}
+
+// Message returns the exception's message.
+func (s *BatchExecuteStatementException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *BatchExecuteStatementException) OrigErr() error {
+ return nil
+}
+
+func (s *BatchExecuteStatementException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *BatchExecuteStatementException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *BatchExecuteStatementException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type BatchExecuteStatementInput struct {
+ _ struct{} `type:"structure"`
+
+ // The cluster identifier. This parameter is required when authenticating using
+ // either Secrets Manager or temporary credentials.
+ //
+ // ClusterIdentifier is a required field
+ ClusterIdentifier *string `type:"string" required:"true"`
+
+ // The name of the database. This parameter is required when authenticating
+ // using either Secrets Manager or temporary credentials.
+ //
+ // Database is a required field
+ Database *string `type:"string" required:"true"`
+
+ // The database user name. This parameter is required when authenticating using
+ // temporary credentials.
+ DbUser *string `type:"string"`
+
+ // The name or ARN of the secret that enables access to the database. This parameter
+ // is required when authenticating using Secrets Manager.
+ SecretArn *string `type:"string"`
+
+ // One or more SQL statements to run.
+ //
+ // Sqls is a required field
+ Sqls []*string `min:"1" type:"list" required:"true"`
+
+ // The name of the SQL statements. You can name the SQL statements when you
+ // create them to identify the query.
+ StatementName *string `type:"string"`
+
+ // A value that indicates whether to send an event to the Amazon EventBridge
+ // event bus after the SQL statements run.
+ WithEvent *bool `type:"boolean"`
+}
+
+// String returns the string representation
+func (s BatchExecuteStatementInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s BatchExecuteStatementInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *BatchExecuteStatementInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "BatchExecuteStatementInput"}
+ if s.ClusterIdentifier == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier"))
+ }
+ if s.Database == nil {
+ invalidParams.Add(request.NewErrParamRequired("Database"))
+ }
+ if s.Sqls == nil {
+ invalidParams.Add(request.NewErrParamRequired("Sqls"))
+ }
+ if s.Sqls != nil && len(s.Sqls) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Sqls", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClusterIdentifier sets the ClusterIdentifier field's value.
+func (s *BatchExecuteStatementInput) SetClusterIdentifier(v string) *BatchExecuteStatementInput {
+ s.ClusterIdentifier = &v
+ return s
+}
+
+// SetDatabase sets the Database field's value.
+func (s *BatchExecuteStatementInput) SetDatabase(v string) *BatchExecuteStatementInput {
+ s.Database = &v
+ return s
+}
+
+// SetDbUser sets the DbUser field's value.
+func (s *BatchExecuteStatementInput) SetDbUser(v string) *BatchExecuteStatementInput {
+ s.DbUser = &v
+ return s
+}
+
+// SetSecretArn sets the SecretArn field's value.
+func (s *BatchExecuteStatementInput) SetSecretArn(v string) *BatchExecuteStatementInput {
+ s.SecretArn = &v
+ return s
+}
+
+// SetSqls sets the Sqls field's value.
+func (s *BatchExecuteStatementInput) SetSqls(v []*string) *BatchExecuteStatementInput {
+ s.Sqls = v
+ return s
+}
+
+// SetStatementName sets the StatementName field's value.
+func (s *BatchExecuteStatementInput) SetStatementName(v string) *BatchExecuteStatementInput {
+ s.StatementName = &v
+ return s
+}
+
+// SetWithEvent sets the WithEvent field's value.
+func (s *BatchExecuteStatementInput) SetWithEvent(v bool) *BatchExecuteStatementInput {
+ s.WithEvent = &v
+ return s
+}
+
+type BatchExecuteStatementOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The cluster identifier.
+ ClusterIdentifier *string `type:"string"`
+
+ // The date and time (UTC) the statement was created.
+ CreatedAt *time.Time `type:"timestamp"`
+
+ // The name of the database.
+ Database *string `type:"string"`
+
+ // The database user name.
+ DbUser *string `type:"string"`
+
+ // 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.
+ Id *string `type:"string"`
+
+ // The name or ARN of the secret that enables access to the database.
+ SecretArn *string `type:"string"`
+}
+
+// String returns the string representation
+func (s BatchExecuteStatementOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s BatchExecuteStatementOutput) GoString() string {
+ return s.String()
+}
+
+// SetClusterIdentifier sets the ClusterIdentifier field's value.
+func (s *BatchExecuteStatementOutput) SetClusterIdentifier(v string) *BatchExecuteStatementOutput {
+ s.ClusterIdentifier = &v
+ return s
+}
+
+// SetCreatedAt sets the CreatedAt field's value.
+func (s *BatchExecuteStatementOutput) SetCreatedAt(v time.Time) *BatchExecuteStatementOutput {
+ s.CreatedAt = &v
+ return s
+}
+
+// SetDatabase sets the Database field's value.
+func (s *BatchExecuteStatementOutput) SetDatabase(v string) *BatchExecuteStatementOutput {
+ s.Database = &v
+ return s
+}
+
+// SetDbUser sets the DbUser field's value.
+func (s *BatchExecuteStatementOutput) SetDbUser(v string) *BatchExecuteStatementOutput {
+ s.DbUser = &v
+ return s
+}
+
+// SetId sets the Id field's value.
+func (s *BatchExecuteStatementOutput) SetId(v string) *BatchExecuteStatementOutput {
+ s.Id = &v
+ return s
+}
+
+// SetSecretArn sets the SecretArn field's value.
+func (s *BatchExecuteStatementOutput) SetSecretArn(v string) *BatchExecuteStatementOutput {
+ s.SecretArn = &v
+ return s
+}
+
type CancelStatementInput struct {
_ struct{} `type:"structure"`
// 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.
+ // is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.
//
// Id is a required field
Id *string `type:"string" required:"true"`
@@ -1415,8 +1760,11 @@ type DescribeStatementInput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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.
//
// Id is a required field
Id *string `type:"string" required:"true"`
@@ -1499,10 +1847,10 @@ type DescribeStatementOutput struct {
// 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.
+ // COPY, and others. A -1 indicates the value is null.
ResultRows *int64 `type:"long"`
- // The size in bytes of the returned results.
+ // The size in bytes of the returned results. A -1 indicates the value is null.
ResultSize *int64 `type:"long"`
// The name or Amazon Resource Name (ARN) of the secret that enables access
@@ -1528,6 +1876,9 @@ type DescribeStatementOutput struct {
// * SUBMITTED - The query was submitted, but not yet processed.
Status *string `type:"string" enum:"StatusString"`
+ // The SQL statements from a multiple statement run.
+ SubStatements []*SubStatementData `type:"list"`
+
// The date and time (UTC) that the metadata for the SQL statement was last
// updated. An example is the time the status last changed.
UpdatedAt *time.Time `type:"timestamp"`
@@ -1639,6 +1990,12 @@ func (s *DescribeStatementOutput) SetStatus(v string) *DescribeStatementOutput {
return s
}
+// SetSubStatements sets the SubStatements field's value.
+func (s *DescribeStatementOutput) SetSubStatements(v []*SubStatementData) *DescribeStatementOutput {
+ s.SubStatements = v
+ return s
+}
+
// SetUpdatedAt sets the UpdatedAt field's value.
func (s *DescribeStatementOutput) SetUpdatedAt(v time.Time) *DescribeStatementOutput {
s.UpdatedAt = &v
@@ -1649,7 +2006,7 @@ type DescribeTableInput struct {
_ struct{} `type:"structure"`
// The cluster identifier. This parameter is required when authenticating using
- // either AWS Secrets Manager or temporary credentials.
+ // either Secrets Manager or temporary credentials.
//
// ClusterIdentifier is a required field
ClusterIdentifier *string `type:"string" required:"true"`
@@ -1686,7 +2043,7 @@ type DescribeTableInput struct {
Schema *string `type:"string"`
// The name or ARN of the secret that enables access to the database. This parameter
- // is required when authenticating using AWS Secrets Manager.
+ // is required when authenticating using Secrets Manager.
SecretArn *string `type:"string"`
// The table name. If no table is specified, then all tables for all matching
@@ -1886,14 +2243,16 @@ type ExecuteStatementInput struct {
_ struct{} `type:"structure"`
// The cluster identifier. This parameter is required when authenticating using
- // either AWS Secrets Manager or temporary credentials.
+ // either Secrets Manager or temporary credentials.
//
// ClusterIdentifier is a required field
ClusterIdentifier *string `type:"string" required:"true"`
// The name of the database. This parameter is required when authenticating
- // using temporary credentials.
- Database *string `type:"string"`
+ // using either Secrets Manager or temporary credentials.
+ //
+ // Database is a required field
+ Database *string `type:"string" required:"true"`
// The database user name. This parameter is required when authenticating using
// temporary credentials.
@@ -1903,7 +2262,7 @@ type ExecuteStatementInput struct {
Parameters []*SqlParameter `min:"1" type:"list"`
// The name or ARN of the secret that enables access to the database. This parameter
- // is required when authenticating using AWS Secrets Manager.
+ // is required when authenticating using Secrets Manager.
SecretArn *string `type:"string"`
// The SQL statement text to run.
@@ -1936,6 +2295,9 @@ func (s *ExecuteStatementInput) Validate() error {
if s.ClusterIdentifier == nil {
invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier"))
}
+ if s.Database == nil {
+ invalidParams.Add(request.NewErrParamRequired("Database"))
+ }
if s.Parameters != nil && len(s.Parameters) < 1 {
invalidParams.Add(request.NewErrParamMinLen("Parameters", 1))
}
@@ -2022,8 +2384,9 @@ type ExecuteStatementOutput struct {
// The database user name.
DbUser *string `type:"string"`
- // The identifier of the statement to be run. This value is a universally unique
- // identifier (UUID) generated by Amazon Redshift Data API.
+ // 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.
Id *string `type:"string"`
// The name or ARN of the secret that enables access to the database.
@@ -2152,7 +2515,10 @@ type GetStatementResultInput struct {
// 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.
+ // 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.
//
// Id is a required field
Id *string `type:"string" required:"true"`
@@ -2319,14 +2685,16 @@ type ListDatabasesInput struct {
_ struct{} `type:"structure"`
// The cluster identifier. This parameter is required when authenticating using
- // either AWS Secrets Manager or temporary credentials.
+ // either Secrets Manager or temporary credentials.
//
// ClusterIdentifier is a required field
ClusterIdentifier *string `type:"string" required:"true"`
// The name of the database. This parameter is required when authenticating
- // using temporary credentials.
- Database *string `type:"string"`
+ // using either Secrets Manager or temporary credentials.
+ //
+ // Database is a required field
+ Database *string `type:"string" required:"true"`
// The database user name. This parameter is required when authenticating using
// temporary credentials.
@@ -2345,7 +2713,7 @@ type ListDatabasesInput struct {
NextToken *string `type:"string"`
// The name or ARN of the secret that enables access to the database. This parameter
- // is required when authenticating using AWS Secrets Manager.
+ // is required when authenticating using Secrets Manager.
SecretArn *string `type:"string"`
}
@@ -2365,6 +2733,9 @@ func (s *ListDatabasesInput) Validate() error {
if s.ClusterIdentifier == nil {
invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier"))
}
+ if s.Database == nil {
+ invalidParams.Add(request.NewErrParamRequired("Database"))
+ }
if invalidParams.Len() > 0 {
return invalidParams
@@ -2448,7 +2819,7 @@ type ListSchemasInput struct {
_ struct{} `type:"structure"`
// The cluster identifier. This parameter is required when authenticating using
- // either AWS Secrets Manager or temporary credentials.
+ // either Secrets Manager or temporary credentials.
//
// ClusterIdentifier is a required field
ClusterIdentifier *string `type:"string" required:"true"`
@@ -2486,7 +2857,7 @@ type ListSchemasInput struct {
SchemaPattern *string `type:"string"`
// The name or ARN of the secret that enables access to the database. This parameter
- // is required when authenticating using AWS Secrets Manager.
+ // is required when authenticating using Secrets Manager.
SecretArn *string `type:"string"`
}
@@ -2621,12 +2992,12 @@ type ListStatementsInput struct {
// The default is true.
RoleLevel *bool `type:"boolean"`
- // 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.
StatementName *string `type:"string"`
// The status of the SQL statement to list. Status values are defined as follows:
@@ -2730,7 +3101,7 @@ type ListTablesInput struct {
_ struct{} `type:"structure"`
// The cluster identifier. This parameter is required when authenticating using
- // either AWS Secrets Manager or temporary credentials.
+ // either Secrets Manager or temporary credentials.
//
// ClusterIdentifier is a required field
ClusterIdentifier *string `type:"string" required:"true"`
@@ -2771,7 +3142,7 @@ type ListTablesInput struct {
SchemaPattern *string `type:"string"`
// The name or ARN of the secret that enables access to the database. This parameter
- // is required when authenticating using AWS Secrets Manager.
+ // is required when authenticating using Secrets Manager.
SecretArn *string `type:"string"`
// A pattern to filter results by table name. Within a table pattern, "%" means
@@ -3032,12 +3403,19 @@ type StatementData struct {
// Id is a required field
Id *string `type:"string" required:"true"`
+ // A value that indicates whether the statement is a batch query request.
+ IsBatchStatement *bool `type:"boolean"`
+
// The parameters used in a SQL statement.
QueryParameters []*SqlParameter `min:"1" type:"list"`
// The SQL statement.
QueryString *string `type:"string"`
+ // One or more SQL statements. Each query string in the array corresponds to
+ // one of the queries in a batch query request.
+ QueryStrings []*string `type:"list"`
+
// The name or Amazon Resource Name (ARN) of the secret that enables access
// to the database.
SecretArn *string `type:"string"`
@@ -3075,6 +3453,12 @@ func (s *StatementData) SetId(v string) *StatementData {
return s
}
+// SetIsBatchStatement sets the IsBatchStatement field's value.
+func (s *StatementData) SetIsBatchStatement(v bool) *StatementData {
+ s.IsBatchStatement = &v
+ return s
+}
+
// SetQueryParameters sets the QueryParameters field's value.
func (s *StatementData) SetQueryParameters(v []*SqlParameter) *StatementData {
s.QueryParameters = v
@@ -3087,6 +3471,12 @@ func (s *StatementData) SetQueryString(v string) *StatementData {
return s
}
+// SetQueryStrings sets the QueryStrings field's value.
+func (s *StatementData) SetQueryStrings(v []*string) *StatementData {
+ s.QueryStrings = v
+ return s
+}
+
// SetSecretArn sets the SecretArn field's value.
func (s *StatementData) SetSecretArn(v string) *StatementData {
s.SecretArn = &v
@@ -3111,6 +3501,132 @@ func (s *StatementData) SetUpdatedAt(v time.Time) *StatementData {
return s
}
+// Information about an SQL statement.
+type SubStatementData struct {
+ _ struct{} `type:"structure"`
+
+ // The date and time (UTC) the statement was created.
+ CreatedAt *time.Time `type:"timestamp"`
+
+ // The amount of time in nanoseconds that the statement ran.
+ Duration *int64 `type:"long"`
+
+ // The error message from the cluster if the SQL statement encountered an error
+ // while running.
+ Error *string `type:"string"`
+
+ // A value that indicates whether the statement has a result set. The result
+ // set can be empty.
+ HasResultSet *bool `type:"boolean"`
+
+ // 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.
+ //
+ // Id is a required field
+ Id *string `type:"string" required:"true"`
+
+ // The SQL statement text.
+ QueryString *string `type:"string"`
+
+ // The SQL statement identifier. This value is a universally unique identifier
+ // (UUID) generated by Amazon Redshift Data API.
+ RedshiftQueryId *int64 `type:"long"`
+
+ // 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.
+ ResultRows *int64 `type:"long"`
+
+ // The size in bytes of the returned results. A -1 indicates the value is null.
+ ResultSize *int64 `type:"long"`
+
+ // The status of the SQL statement. An example is the that the SQL statement
+ // finished.
+ Status *string `type:"string" enum:"StatementStatusString"`
+
+ // The date and time (UTC) that the statement metadata was last updated.
+ UpdatedAt *time.Time `type:"timestamp"`
+}
+
+// String returns the string representation
+func (s SubStatementData) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s SubStatementData) GoString() string {
+ return s.String()
+}
+
+// SetCreatedAt sets the CreatedAt field's value.
+func (s *SubStatementData) SetCreatedAt(v time.Time) *SubStatementData {
+ s.CreatedAt = &v
+ return s
+}
+
+// SetDuration sets the Duration field's value.
+func (s *SubStatementData) SetDuration(v int64) *SubStatementData {
+ s.Duration = &v
+ return s
+}
+
+// SetError sets the Error field's value.
+func (s *SubStatementData) SetError(v string) *SubStatementData {
+ s.Error = &v
+ return s
+}
+
+// SetHasResultSet sets the HasResultSet field's value.
+func (s *SubStatementData) SetHasResultSet(v bool) *SubStatementData {
+ s.HasResultSet = &v
+ return s
+}
+
+// SetId sets the Id field's value.
+func (s *SubStatementData) SetId(v string) *SubStatementData {
+ s.Id = &v
+ return s
+}
+
+// SetQueryString sets the QueryString field's value.
+func (s *SubStatementData) SetQueryString(v string) *SubStatementData {
+ s.QueryString = &v
+ return s
+}
+
+// SetRedshiftQueryId sets the RedshiftQueryId field's value.
+func (s *SubStatementData) SetRedshiftQueryId(v int64) *SubStatementData {
+ s.RedshiftQueryId = &v
+ return s
+}
+
+// SetResultRows sets the ResultRows field's value.
+func (s *SubStatementData) SetResultRows(v int64) *SubStatementData {
+ s.ResultRows = &v
+ return s
+}
+
+// SetResultSize sets the ResultSize field's value.
+func (s *SubStatementData) SetResultSize(v int64) *SubStatementData {
+ s.ResultSize = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *SubStatementData) SetStatus(v string) *SubStatementData {
+ s.Status = &v
+ return s
+}
+
+// SetUpdatedAt sets the UpdatedAt field's value.
+func (s *SubStatementData) SetUpdatedAt(v time.Time) *SubStatementData {
+ s.UpdatedAt = &v
+ return s
+}
+
// The properties of a table.
type TableMember struct {
_ struct{} `type:"structure"`
@@ -3211,6 +3727,38 @@ func (s *ValidationException) RequestID() string {
return s.RespMetadata.RequestID
}
+const (
+ // StatementStatusStringSubmitted is a StatementStatusString enum value
+ StatementStatusStringSubmitted = "SUBMITTED"
+
+ // StatementStatusStringPicked is a StatementStatusString enum value
+ StatementStatusStringPicked = "PICKED"
+
+ // StatementStatusStringStarted is a StatementStatusString enum value
+ StatementStatusStringStarted = "STARTED"
+
+ // StatementStatusStringFinished is a StatementStatusString enum value
+ StatementStatusStringFinished = "FINISHED"
+
+ // StatementStatusStringAborted is a StatementStatusString enum value
+ StatementStatusStringAborted = "ABORTED"
+
+ // StatementStatusStringFailed is a StatementStatusString enum value
+ StatementStatusStringFailed = "FAILED"
+)
+
+// StatementStatusString_Values returns all elements of the StatementStatusString enum
+func StatementStatusString_Values() []string {
+ return []string{
+ StatementStatusStringSubmitted,
+ StatementStatusStringPicked,
+ StatementStatusStringStarted,
+ StatementStatusStringFinished,
+ StatementStatusStringAborted,
+ StatementStatusStringFailed,
+ }
+}
+
const (
// StatusStringSubmitted is a StatusString enum value
StatusStringSubmitted = "SUBMITTED"
diff --git a/service/redshiftdataapiservice/doc.go b/service/redshiftdataapiservice/doc.go
index a945e64772..979fecbf8f 100644
--- a/service/redshiftdataapiservice/doc.go
+++ b/service/redshiftdataapiservice/doc.go
@@ -4,8 +4,8 @@
// requests to Redshift Data API Service.
//
// 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.
+// 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 (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html)
diff --git a/service/redshiftdataapiservice/errors.go b/service/redshiftdataapiservice/errors.go
index 61c45d3355..73101095fb 100644
--- a/service/redshiftdataapiservice/errors.go
+++ b/service/redshiftdataapiservice/errors.go
@@ -14,6 +14,12 @@ const (
// The number of active statements exceeds the limit.
ErrCodeActiveStatementsExceededException = "ActiveStatementsExceededException"
+ // ErrCodeBatchExecuteStatementException for service response error code
+ // "BatchExecuteStatementException".
+ //
+ // An SQL statement encountered an environmental error while running.
+ ErrCodeBatchExecuteStatementException = "BatchExecuteStatementException"
+
// ErrCodeExecuteStatementException for service response error code
// "ExecuteStatementException".
//
@@ -41,6 +47,7 @@ const (
var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{
"ActiveStatementsExceededException": newErrorActiveStatementsExceededException,
+ "BatchExecuteStatementException": newErrorBatchExecuteStatementException,
"ExecuteStatementException": newErrorExecuteStatementException,
"InternalServerException": newErrorInternalServerException,
"ResourceNotFoundException": newErrorResourceNotFoundException,
diff --git a/service/redshiftdataapiservice/redshiftdataapiserviceiface/interface.go b/service/redshiftdataapiservice/redshiftdataapiserviceiface/interface.go
index ae056a82d2..be01d5e5e2 100644
--- a/service/redshiftdataapiservice/redshiftdataapiserviceiface/interface.go
+++ b/service/redshiftdataapiservice/redshiftdataapiserviceiface/interface.go
@@ -26,7 +26,7 @@ import (
// // myFunc uses an SDK service client to make a request to
// // Redshift Data API Service.
// func myFunc(svc redshiftdataapiserviceiface.RedshiftDataAPIServiceAPI) bool {
-// // Make svc.CancelStatement request
+// // Make svc.BatchExecuteStatement request
// }
//
// func main() {
@@ -42,7 +42,7 @@ import (
// type mockRedshiftDataAPIServiceClient struct {
// redshiftdataapiserviceiface.RedshiftDataAPIServiceAPI
// }
-// func (m *mockRedshiftDataAPIServiceClient) CancelStatement(input *redshiftdataapiservice.CancelStatementInput) (*redshiftdataapiservice.CancelStatementOutput, error) {
+// func (m *mockRedshiftDataAPIServiceClient) BatchExecuteStatement(input *redshiftdataapiservice.BatchExecuteStatementInput) (*redshiftdataapiservice.BatchExecuteStatementOutput, error) {
// // mock response/functionality
// }
//
@@ -60,6 +60,10 @@ import (
// and waiters. Its suggested to use the pattern above for testing, or using
// tooling to generate mocks to satisfy the interfaces.
type RedshiftDataAPIServiceAPI interface {
+ BatchExecuteStatement(*redshiftdataapiservice.BatchExecuteStatementInput) (*redshiftdataapiservice.BatchExecuteStatementOutput, error)
+ BatchExecuteStatementWithContext(aws.Context, *redshiftdataapiservice.BatchExecuteStatementInput, ...request.Option) (*redshiftdataapiservice.BatchExecuteStatementOutput, error)
+ BatchExecuteStatementRequest(*redshiftdataapiservice.BatchExecuteStatementInput) (*request.Request, *redshiftdataapiservice.BatchExecuteStatementOutput)
+
CancelStatement(*redshiftdataapiservice.CancelStatementInput) (*redshiftdataapiservice.CancelStatementOutput, error)
CancelStatementWithContext(aws.Context, *redshiftdataapiservice.CancelStatementInput, ...request.Option) (*redshiftdataapiservice.CancelStatementOutput, error)
CancelStatementRequest(*redshiftdataapiservice.CancelStatementInput) (*request.Request, *redshiftdataapiservice.CancelStatementOutput)
diff --git a/service/route53/api.go b/service/route53/api.go
index 70f7d97d43..0b884380f7 100644
--- a/service/route53/api.go
+++ b/service/route53/api.go
@@ -87,6 +87,9 @@ func (c *Route53) ActivateKeySigningKeyRequest(input *ActivateKeySigningKeyInput
// The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC
// signing.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/ActivateKeySigningKey
func (c *Route53) ActivateKeySigningKey(input *ActivateKeySigningKeyInput) (*ActivateKeySigningKeyOutput, error) {
req, out := c.ActivateKeySigningKeyRequest(input)
@@ -158,11 +161,11 @@ func (c *Route53) AssociateVPCWithHostedZoneRequest(input *AssociateVPCWithHoste
// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -217,7 +220,7 @@ func (c *Route53) AssociateVPCWithHostedZoneRequest(input *AssociateVPCWithHoste
// To get the current limit on the number of Amazon VPCs that you can associate
// with a private hosted zone, see GetHostedZoneLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetHostedZoneLimit.html).
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodePriorRequestNotComplete "PriorRequestNotComplete"
// If Amazon Route 53 can't process a request before the next request arrives,
@@ -344,9 +347,9 @@ func (c *Route53) ChangeResourceRecordSetsRequest(input *ChangeResourceRecordSet
// * 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.
+// * 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
//
@@ -474,7 +477,7 @@ func (c *Route53) ChangeTagsForResourceRequest(input *ChangeTagsForResourceInput
//
// For information about using tags for cost allocation, see Using Cost Allocation
// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
-// in the AWS Billing and Cost Management User Guide.
+// in the Billing and Cost Management User Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -621,11 +624,11 @@ func (c *Route53) CreateHealthCheckRequest(input *CreateHealthCheckInput) (req *
// For information about how to get the current limit for an account, see GetAccountLimit
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
-// You have reached the maximum number of active health checks for an AWS account.
+// You have reached the maximum number of active health checks for an account.
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodeHealthCheckAlreadyExists "HealthCheckAlreadyExists"
// The health check you're attempting to create already exists. Amazon Route
@@ -781,7 +784,7 @@ func (c *Route53) CreateHostedZoneRequest(input *CreateHostedZoneInput) (req *re
// delegation set, see GetReusableDelegationSetLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodeInvalidVPCId "InvalidVPCId"
// The VPC ID that you specified either isn't a valid ID or the current account
@@ -1027,17 +1030,17 @@ func (c *Route53) CreateQueryLoggingConfigRequest(input *CreateQueryLoggingConfi
//
// * 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
+// * 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 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.
+// 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.
@@ -1049,7 +1052,8 @@ func (c *Route53) CreateQueryLoggingConfigRequest(input *CreateQueryLoggingConfi
// 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.
+// You must use the CloudWatch API, one of the Amazon Web Services SDKs, or
+// the CLI.
//
// Log Streams and Edge Locations
//
@@ -1142,6 +1146,10 @@ func (c *Route53) CreateQueryLoggingConfigRequest(input *CreateQueryLoggingConfi
//
// * 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.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/CreateQueryLoggingConfig
func (c *Route53) CreateQueryLoggingConfig(input *CreateQueryLoggingConfigInput) (*CreateQueryLoggingConfigOutput, error) {
req, out := c.CreateQueryLoggingConfigRequest(input)
@@ -1209,7 +1217,7 @@ func (c *Route53) CreateReusableDelegationSetRequest(input *CreateReusableDelega
// CreateReusableDelegationSet API operation for Amazon Route 53.
//
// 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.
+// 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
@@ -1277,7 +1285,7 @@ func (c *Route53) CreateReusableDelegationSetRequest(input *CreateReusableDelega
// To get the current limit on the number of Amazon VPCs that you can associate
// with a private hosted zone, see GetHostedZoneLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetHostedZoneLimit.html).
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodeHostedZoneNotFound "HostedZoneNotFound"
// The specified HostedZone can't be found.
@@ -1389,7 +1397,7 @@ func (c *Route53) CreateTrafficPolicyRequest(input *CreateTrafficPolicyInput) (r
// To get the current limit for an account, see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodeTrafficPolicyAlreadyExists "TrafficPolicyAlreadyExists"
// A traffic policy that has the same value for Name already exists.
@@ -1496,7 +1504,7 @@ func (c *Route53) CreateTrafficPolicyInstanceRequest(input *CreateTrafficPolicyI
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
-// with the AWS Support Center.
+// with the Amazon Web Services Support Center.
//
// * ErrCodeNoSuchTrafficPolicy "NoSuchTrafficPolicy"
// No traffic policy exists with the specified ID.
@@ -1677,7 +1685,7 @@ func (c *Route53) CreateVPCAssociationAuthorizationRequest(input *CreateVPCAssoc
// CreateVPCAssociationAuthorization API operation for Amazon Route 53.
//
-// Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone
+// 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
@@ -1817,6 +1825,9 @@ func (c *Route53) DeactivateKeySigningKeyRequest(input *DeactivateKeySigningKeyI
// * ErrCodeKeySigningKeyInParentDSRecord "KeySigningKeyInParentDSRecord"
// The key-signing key (KSK) is specified in a parent DS record.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeactivateKeySigningKey
func (c *Route53) DeactivateKeySigningKey(input *DeactivateKeySigningKeyInput) (*DeactivateKeySigningKeyOutput, error) {
req, out := c.DeactivateKeySigningKeyRequest(input)
@@ -1894,7 +1905,7 @@ func (c *Route53) DeleteHealthCheckRequest(input *DeleteHealthCheckInput) (req *
// For more information, see Replacing and Deleting Health Checks (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html#health-checks-deleting.html)
// in the Amazon Route 53 Developer Guide.
//
-// If you're using AWS Cloud Map and you configured Cloud Map to create a Route
+// 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
@@ -1985,8 +1996,8 @@ func (c *Route53) DeleteHostedZoneRequest(input *DeleteHostedZoneInput) (req *re
//
// 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 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html#delete-public-hosted-zone-created-by-another-service)
+// If the hosted zone was created by another service, such as Cloud Map, see
+// Deleting Public Hosted Zones That Were Created by Another Service (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html#delete-public-hosted-zone-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.)
@@ -2028,7 +2039,7 @@ func (c *Route53) DeleteHostedZoneRequest(input *DeleteHostedZoneInput) (req *re
// zone.
//
// * Use the ListHostedZones action to get a list of the hosted zones associated
-// with the current AWS account.
+// with the current account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2154,6 +2165,9 @@ func (c *Route53) DeleteKeySigningKeyRequest(input *DeleteKeySigningKeyInput) (r
// The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC
// signing.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DeleteKeySigningKey
func (c *Route53) DeleteKeySigningKey(input *DeleteKeySigningKeyInput) (*DeleteKeySigningKeyOutput, error) {
req, out := c.DeleteKeySigningKeyRequest(input)
@@ -2612,7 +2626,7 @@ func (c *Route53) DeleteVPCAssociationAuthorizationRequest(input *DeleteVPCAssoc
// 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
+// 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
@@ -2745,6 +2759,9 @@ func (c *Route53) DisableHostedZoneDNSSECRequest(input *DisableHostedZoneDNSSECI
// The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC
// signing.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/DisableHostedZoneDNSSEC
func (c *Route53) DisableHostedZoneDNSSEC(input *DisableHostedZoneDNSSECInput) (*DisableHostedZoneDNSSECOutput, error) {
req, out := c.DisableHostedZoneDNSSECRequest(input)
@@ -2822,12 +2839,12 @@ func (c *Route53) DisassociateVPCFromHostedZoneRequest(input *DisassociateVPCFro
// 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 (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html),
+// * 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
+// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html),
// 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.
//
@@ -2961,6 +2978,9 @@ func (c *Route53) EnableHostedZoneDNSSECRequest(input *EnableHostedZoneDNSSECInp
// The key-signing key (KSK) status isn't valid or another KSK has the status
// INTERNAL_FAILURE.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/EnableHostedZoneDNSSEC
func (c *Route53) EnableHostedZoneDNSSEC(input *EnableHostedZoneDNSSECInput) (*EnableHostedZoneDNSSECOutput, error) {
req, out := c.EnableHostedZoneDNSSECRequest(input)
@@ -3034,10 +3054,10 @@ func (c *Route53) GetAccountLimitRequest(input *GetAccountLimitInput) (req *requ
// in the Amazon Route 53 Developer Guide. To request a higher limit, open a
// case (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53).
//
-// 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/
-// (https://console.aws.amazon.com/trustedadvisor). Then choose Service limits
-// in the navigation pane.
+// 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/ (https://console.aws.amazon.com/trustedadvisor).
+// Then choose Service limits in the navigation pane.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3210,8 +3230,8 @@ func (c *Route53) GetCheckerIpRangesRequest(input *GetCheckerIpRangesInput) (req
// 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 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html)
+// which includes IP address ranges for all Amazon Web Services services. For
+// more information, see IP Address Ranges of Amazon Route 53 Servers (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html)
// in the Amazon Route 53 Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -3303,6 +3323,9 @@ func (c *Route53) GetDNSSECRequest(input *GetDNSSECInput) (req *request.Request,
// * ErrCodeInvalidArgument "InvalidArgument"
// Parameter name is not valid.
//
+// * ErrCodeInvalidInput "InvalidInput"
+// The input is not valid.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-2013-04-01/GetDNSSEC
func (c *Route53) GetDNSSEC(input *GetDNSSECInput) (*GetDNSSECOutput, error) {
req, out := c.GetDNSSECRequest(input)
@@ -3560,7 +3583,7 @@ func (c *Route53) GetHealthCheckCountRequest(input *GetHealthCheckCountInput) (r
// GetHealthCheckCount API operation for Amazon Route 53.
//
// Retrieves the number of health checks that are associated with the current
-// AWS account.
+// account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3718,6 +3741,10 @@ func (c *Route53) GetHealthCheckStatusRequest(input *GetHealthCheckStatusInput)
//
// 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.
+//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
@@ -3882,7 +3909,7 @@ func (c *Route53) GetHostedZoneCountRequest(input *GetHostedZoneCountInput) (req
// GetHostedZoneCount API operation for Amazon Route 53.
//
// Retrieves the number of hosted zones that are associated with the current
-// AWS account.
+// account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4484,7 +4511,7 @@ func (c *Route53) GetTrafficPolicyInstanceCountRequest(input *GetTrafficPolicyIn
// GetTrafficPolicyInstanceCount API operation for Amazon Route 53.
//
// Gets the number of traffic policy instances that are associated with the
-// current AWS account.
+// current account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4655,7 +4682,7 @@ func (c *Route53) ListHealthChecksRequest(input *ListHealthChecksInput) (req *re
// ListHealthChecks API operation for Amazon Route 53.
//
// Retrieve a list of the health checks that are associated with the current
-// AWS account.
+// account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4797,7 +4824,7 @@ func (c *Route53) ListHostedZonesRequest(input *ListHostedZonesInput) (req *requ
// ListHostedZones API operation for Amazon Route 53.
//
// 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
+// 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
@@ -4941,7 +4968,7 @@ func (c *Route53) ListHostedZonesByNameRequest(input *ListHostedZonesByNameInput
//
// 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.
+// current account.
//
// ListHostedZonesByName sorts hosted zones by name with the labels reversed.
// For example:
@@ -4977,17 +5004,16 @@ func (c *Route53) ListHostedZonesByNameRequest(input *ListHostedZonesByNameInput
// 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.
+// 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 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5070,16 +5096,18 @@ func (c *Route53) ListHostedZonesByVPCRequest(input *ListHostedZonesByVPCInput)
// ListHostedZonesByVPC API operation for Amazon Route 53.
//
// 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:
+// 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 AWS account or another AWS account. Some services, such as
-// AWS Cloud Map, create hosted zones using the current account.
+// 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 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.
+// * 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5169,7 +5197,7 @@ func (c *Route53) ListQueryLoggingConfigsRequest(input *ListQueryLoggingConfigsI
// ListQueryLoggingConfigs API operation for Amazon Route 53.
//
// Lists the configurations for DNS query logging that are associated with the
-// current AWS account or the configuration that is associated with a specified
+// current account or the configuration that is associated with a specified
// hosted zone.
//
// For more information about DNS query logs, see CreateQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html).
@@ -5518,7 +5546,7 @@ func (c *Route53) ListReusableDelegationSetsRequest(input *ListReusableDelegatio
// ListReusableDelegationSets API operation for Amazon Route 53.
//
// Retrieves a list of the reusable delegation sets that are associated with
-// the current AWS account.
+// the current account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5601,7 +5629,7 @@ func (c *Route53) ListTagsForResourceRequest(input *ListTagsForResourceInput) (r
//
// For information about using tags for cost allocation, see Using Cost Allocation
// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
-// in the AWS Billing and Cost Management User Guide.
+// in the Billing and Cost Management User Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5700,7 +5728,7 @@ func (c *Route53) ListTagsForResourcesRequest(input *ListTagsForResourcesInput)
//
// For information about using tags for cost allocation, see Using Cost Allocation
// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
-// in the AWS Billing and Cost Management User Guide.
+// in the Billing and Cost Management User Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -5796,8 +5824,8 @@ func (c *Route53) ListTrafficPoliciesRequest(input *ListTrafficPoliciesInput) (r
// ListTrafficPolicies API operation for Amazon Route 53.
//
// 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.
+// 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 (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html).
@@ -5880,7 +5908,7 @@ func (c *Route53) ListTrafficPolicyInstancesRequest(input *ListTrafficPolicyInst
// ListTrafficPolicyInstances API operation for Amazon Route 53.
//
// Gets information about the traffic policy instances that you created by using
-// the current AWS account.
+// 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
@@ -6969,9 +6997,9 @@ func (s *AlarmIdentifier) SetRegion(v string) *AlarmIdentifier {
return s
}
-// 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.
+// 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:
//
@@ -6989,7 +7017,7 @@ type AliasTarget struct {
// Amazon API Gateway custom regional APIs and edge-optimized APIs
//
// Specify the applicable domain name for your API. You can get the applicable
- // value using the AWS CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html):
+ // value using the CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html):
//
// * For regional APIs, specify the value of regionalDomainName.
//
@@ -7003,8 +7031,8 @@ type AliasTarget struct {
//
// 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 (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).
+ // distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints
+ // (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).
//
// CloudFront distribution
//
@@ -7045,30 +7073,29 @@ type AliasTarget struct {
// 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
- // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html)
- // in the AWS Elastic Beanstalk Developer Guide.
+ // * Management Console: For information about how to get the value by using
+ // the console, see Using Custom Domains with Elastic Beanstalk (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html)
+ // 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
// (https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html)
- // in the AWS Elastic Beanstalk API Reference.
+ // in the 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 (https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html)
- // in the AWS CLI Command Reference.
+ // * CLI: Use the describe-environments command to get the value of the CNAME
+ // attribute. For more information, see describe-environments (https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html)
+ // in the CLI Command Reference.
//
// ELB load balancer
//
// 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.
+ // name by using the Management Console, the ELB API, or the 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
+ // * 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
@@ -7076,19 +7103,19 @@ type AliasTarget struct {
// Balancers: DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html)
// Application and Network Load Balancers: DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
//
- // * 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
+ // * CLI: Use describe-load-balancers to get the value of DNSName. For more
+ // information, see the applicable guide: Classic Load Balancers: describe-load-balancers
// (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)
// Application and Network Load Balancers: describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)
//
- // AWS Global Accelerator accelerator
+ // Global Accelerator accelerator
//
// Specify the DNS name for your accelerator:
//
// * Global Accelerator API: To get the DNS name, use DescribeAccelerator
// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html).
//
- // * AWS CLI: To get the DNS name, use describe-accelerator (https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html).
+ // * CLI: To get the DNS name, use describe-accelerator (https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html).
//
// Amazon S3 bucket that is configured as a static website
//
@@ -7116,9 +7143,9 @@ type AliasTarget struct {
// 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.
+ // 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:
//
@@ -7174,11 +7201,11 @@ type AliasTarget struct {
//
// Other records in the same hosted zone
//
- // 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? (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting)
+ // 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? (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting)
// in the Amazon Route 53 Developer Guide.
//
// For more information and examples, see Amazon Route 53 Health Checks and
@@ -7194,7 +7221,7 @@ type AliasTarget struct {
// Amazon API Gateway custom regional APIs and edge-optimized APIs
//
// Specify the hosted zone ID for your API. You can get the applicable value
- // using the AWS CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html):
+ // using the CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html):
//
// * For regional APIs, specify the value of regionalHostedZoneId.
//
@@ -7203,7 +7230,7 @@ type AliasTarget struct {
// Amazon Virtual Private Cloud interface VPC endpoint
//
// Specify the hosted zone ID for your interface endpoint. You can get the value
- // of HostedZoneId using the AWS CLI command describe-vpc-endpoints (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).
+ // of HostedZoneId using the CLI command describe-vpc-endpoints (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).
//
// CloudFront distribution
//
@@ -7215,8 +7242,8 @@ type AliasTarget struct {
//
// 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 (https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html)
+ // and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and
+ // quotas (https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html)
// in the the Amazon Web Services General Reference.
//
// ELB load balancer
@@ -7230,7 +7257,7 @@ type AliasTarget struct {
// 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
+ // * 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.
//
@@ -7241,14 +7268,14 @@ type AliasTarget struct {
// Load Balancers: Use DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html)
// 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 (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)
+ // * CLI: Use describe-load-balancers to get the applicable value. For more
+ // information, see the applicable guide: Classic Load Balancers: Use describe-load-balancers
+ // (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html)
// to get the value of CanonicalHostedZoneNameId. Application and Network
// Load Balancers: Use describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html)
// to get the value of CanonicalHostedZoneId.
//
- // AWS Global Accelerator accelerator
+ // Global Accelerator accelerator
//
// Specify Z2BJ6XQ5FK7U4H.
//
@@ -7556,14 +7583,11 @@ func (s *ChangeBatch) SetComment(v string) *ChangeBatch {
type ChangeInfo struct {
_ struct{} `type:"structure"`
- // 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 (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html)
- // action to get detailed information about the change.
+ // A comment you can provide.
Comment *string `type:"string"`
- // The ID of the request.
+ // This element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html)
+ // action to get detailed information about the change.
//
// Id is a required field
Id *string `type:"string" required:"true"`
@@ -8246,10 +8270,10 @@ type CreateKeySigningKeyInput struct {
HostedZoneId *string `type:"string" required:"true"`
// 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.
+ // (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:
//
@@ -8278,10 +8302,10 @@ type CreateKeySigningKeyInput struct {
// 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"
+ // * "Service": "dnssec-route53.amazonaws.com"
//
- // For more information about working with a customer managed CMK in AWS KMS,
- // see AWS Key Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html).
+ // For more information about working with a customer managed CMK in KMS, see
+ // Key Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html).
//
// KeyManagementServiceArn is a required field
KeyManagementServiceArn *string `type:"string" required:"true"`
@@ -8433,7 +8457,7 @@ type CreateQueryLoggingConfigInput struct {
// To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups
// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html)
// API action, the describe-log-groups (https://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html)
- // command, or the applicable command in one of the AWS SDKs.
+ // command, or the applicable command in one of the Amazon Web Services SDKs.
//
// CloudWatchLogsLogGroupArn is a required field
CloudWatchLogsLogGroupArn *string `type:"string" required:"true"`
@@ -9722,21 +9746,21 @@ func (s DeleteTrafficPolicyOutput) GoString() string {
}
// 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.
+// to associate a VPC that was created by one account with a hosted zone that
+// was created with a different account.
type DeleteVPCAssociationAuthorizationInput struct {
_ struct{} `locationName:"DeleteVPCAssociationAuthorizationRequest" type:"structure" xmlURI:"https://route53.amazonaws.com/doc/2013-04-01/"`
- // 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.
+ // 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.
//
// HostedZoneId is a required field
HostedZoneId *string `location:"uri" locationName:"Id" type:"string" required:"true"`
- // 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.
+ // 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.
//
// VPC is a required field
VPC *VPC `type:"structure" required:"true"`
@@ -10646,7 +10670,7 @@ func (s *GetGeoLocationOutput) SetGeoLocationDetails(v *GeoLocationDetails) *Get
}
// A request for the number of health checks that are associated with the current
-// AWS account.
+// account.
type GetHealthCheckCountInput struct {
_ struct{} `locationName:"GetHealthCheckCountRequest" type:"structure"`
}
@@ -10665,7 +10689,7 @@ func (s GetHealthCheckCountInput) GoString() string {
type GetHealthCheckCountOutput struct {
_ struct{} `type:"structure"`
- // The number of health checks associated with the current AWS account.
+ // The number of health checks associated with the current account.
//
// HealthCheckCount is a required field
HealthCheckCount *int64 `type:"long" required:"true"`
@@ -10813,7 +10837,7 @@ type GetHealthCheckOutput struct {
_ struct{} `type:"structure"`
// A complex type that contains information about one health check that is associated
- // with the current AWS account.
+ // with the current account.
//
// HealthCheck is a required field
HealthCheck *HealthCheck `type:"structure" required:"true"`
@@ -10911,7 +10935,7 @@ func (s *GetHealthCheckStatusOutput) SetHealthCheckObservations(v []*HealthCheck
}
// A request to retrieve a count of all the hosted zones that are associated
-// with the current AWS account.
+// with the current account.
type GetHostedZoneCountInput struct {
_ struct{} `locationName:"GetHostedZoneCountRequest" type:"structure"`
}
@@ -10931,7 +10955,7 @@ type GetHostedZoneCountOutput struct {
_ struct{} `type:"structure"`
// The total number of public and private hosted zones that are associated with
- // the current AWS account.
+ // the current account.
//
// HostedZoneCount is a required field
HostedZoneCount *int64 `type:"long" required:"true"`
@@ -11452,7 +11476,7 @@ func (s *GetTrafficPolicyInput) SetVersion(v int64) *GetTrafficPolicyInput {
}
// Request to get the number of traffic policy instances that are associated
-// with the current AWS account.
+// with the current account.
type GetTrafficPolicyInstanceCountInput struct {
_ struct{} `locationName:"GetTrafficPolicyInstanceCountRequest" type:"structure"`
}
@@ -11473,7 +11497,7 @@ type GetTrafficPolicyInstanceCountOutput struct {
_ struct{} `type:"structure"`
// The number of traffic policy instances that are associated with the current
- // AWS account.
+ // account.
//
// TrafficPolicyInstanceCount is a required field
TrafficPolicyInstanceCount *int64 `type:"integer" required:"true"`
@@ -11591,7 +11615,7 @@ func (s *GetTrafficPolicyOutput) SetTrafficPolicy(v *TrafficPolicy) *GetTrafficP
}
// A complex type that contains information about one health check that is associated
-// with the current AWS account.
+// with the current Amazon Web Services account.
type HealthCheck struct {
_ struct{} `type:"structure"`
@@ -11874,8 +11898,9 @@ type HealthCheckConfig struct {
Inverted *bool `type:"boolean"`
// 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.
+ // 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.
MeasureLatency *bool `type:"boolean"`
@@ -11916,6 +11941,10 @@ type HealthCheckConfig struct {
// parameters, for example, /welcome.html?language=jp&login=y.
ResourcePath *string `type:"string"`
+ // The Amazon Resource Name (ARN) for Route53 Application Recovery Controller
+ // routing control.
+ RoutingControlArn *string `min:"1" type:"string"`
+
// If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that
// you want Amazon Route 53 to search for in the response body from the specified
// resource. If the string appears in the response body, Route 53 considers
@@ -11962,6 +11991,11 @@ type HealthCheckConfig struct {
// 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 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
// in the Amazon Route 53 Developer Guide.
@@ -11995,6 +12029,9 @@ func (s *HealthCheckConfig) Validate() error {
if s.RequestInterval != nil && *s.RequestInterval < 10 {
invalidParams.Add(request.NewErrParamMinValue("RequestInterval", 10))
}
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
if s.Type == nil {
invalidParams.Add(request.NewErrParamRequired("Type"))
}
@@ -12100,6 +12137,12 @@ func (s *HealthCheckConfig) SetResourcePath(v string) *HealthCheckConfig {
return s
}
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *HealthCheckConfig) SetRoutingControlArn(v string) *HealthCheckConfig {
+ s.RoutingControlArn = &v
+ return s
+}
+
// SetSearchString sets the SearchString field's value.
func (s *HealthCheckConfig) SetSearchString(v string) *HealthCheckConfig {
s.SearchString = &v
@@ -12329,18 +12372,18 @@ func (s *HostedZoneLimit) SetValue(v int64) *HostedZoneLimit {
type HostedZoneOwner struct {
_ struct{} `type:"structure"`
- // 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.
OwningAccount *string `type:"string"`
- // 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.
OwningService *string `type:"string"`
}
@@ -12386,7 +12429,7 @@ type HostedZoneSummary struct {
Name *string `type:"string" required:"true"`
// 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.
+ // The owner can be either an account or an Amazon Web Services service.
//
// Owner is a required field
Owner *HostedZoneOwner `type:"structure" required:"true"`
@@ -12460,8 +12503,8 @@ type KeySigningKey struct {
KeyTag *int64 `type:"integer"`
// 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.
+ // 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:
//
@@ -12490,10 +12533,10 @@ type KeySigningKey struct {
// 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"
+ // * "Service": "dnssec-route53.amazonaws.com"
//
- // For more information about working with the customer managed CMK in AWS KMS,
- // see AWS Key Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html).
+ // For more information about working with the customer managed CMK in KMS,
+ // see Key Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html).
KmsArn *string `type:"string"`
// The last time that the key-signing key (KSK) was changed.
@@ -12879,7 +12922,7 @@ func (s *ListGeoLocationsOutput) SetNextSubdivisionCode(v string) *ListGeoLocati
}
// A request to retrieve a list of the health checks that are associated with
-// the current AWS account.
+// the current account.
type ListHealthChecksInput struct {
_ struct{} `locationName:"ListHealthChecksRequest" type:"structure"`
@@ -12928,7 +12971,7 @@ type ListHealthChecksOutput struct {
_ struct{} `type:"structure"`
// A complex type that contains one HealthCheck element for each health check
- // that is associated with the current AWS account.
+ // that is associated with the current account.
//
// HealthChecks is a required field
HealthChecks []*HealthCheck `locationNameList:"HealthCheck" type:"list" required:"true"`
@@ -13000,14 +13043,14 @@ func (s *ListHealthChecksOutput) SetNextMarker(v string) *ListHealthChecksOutput
}
// Retrieves a list of the public and private hosted zones that are associated
-// with the current AWS account in ASCII order by domain name.
+// with the current account in ASCII order by domain name.
type ListHostedZonesByNameInput struct {
_ struct{} `locationName:"ListHostedZonesByNameRequest" type:"structure"`
// (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,
+ // 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.
@@ -13162,7 +13205,7 @@ func (s *ListHostedZonesByNameOutput) SetNextHostedZoneId(v string) *ListHostedZ
}
// Lists all the private hosted zones that a specified VPC is associated with,
-// regardless of which AWS account created the hosted zones.
+// regardless of which account created the hosted zones.
type ListHostedZonesByVPCInput struct {
_ struct{} `locationName:"ListHostedZonesByVPCRequest" type:"structure"`
@@ -13189,8 +13232,8 @@ type ListHostedZonesByVPCInput struct {
// VPCId is a required field
VPCId *string `location:"querystring" locationName:"vpcid" type:"string" required:"true"`
- // 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.
//
// VPCRegion is a required field
VPCRegion *string `location:"querystring" locationName:"vpcregion" min:"1" type:"string" required:"true" enum:"VPCRegion"`
@@ -13266,7 +13309,7 @@ type ListHostedZonesByVPCOutput struct {
// MaxItems is a required field
MaxItems *string `type:"string" required:"true"`
- // The value that you specified for NextToken in the most recent ListHostedZonesByVPC
+ // The value that you will use for NextToken in the next ListHostedZonesByVPC
// request.
NextToken *string `type:"string"`
}
@@ -13300,7 +13343,7 @@ func (s *ListHostedZonesByVPCOutput) SetNextToken(v string) *ListHostedZonesByVP
}
// A request to retrieve a list of the public and private hosted zones that
-// are associated with the current AWS account.
+// are associated with the current account.
type ListHostedZonesInput struct {
_ struct{} `locationName:"ListHostedZonesRequest" type:"structure"`
@@ -13440,19 +13483,19 @@ type ListQueryLoggingConfigsInput struct {
// 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.
+ // of the configurations that are associated with the current account.
HostedZoneId *string `location:"querystring" locationName:"hostedzoneid" type:"string"`
// (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
+ // account has more than MaxResults configurations, use the value of NextToken
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax)
// 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.
MaxResults *string `location:"querystring" locationName:"maxresults" type:"string"`
- // (Optional) If the current AWS account has more than MaxResults query logging
+ // (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.
@@ -13494,8 +13537,8 @@ type ListQueryLoggingConfigsOutput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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 (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html)
@@ -13505,7 +13548,7 @@ type ListQueryLoggingConfigsOutput struct {
// An array that contains one QueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_QueryLoggingConfig.html)
// element for each configuration for DNS query logging that is associated with
- // the current AWS account.
+ // the current account.
//
// QueryLoggingConfigs is a required field
QueryLoggingConfigs []*QueryLoggingConfig `locationNameList:"QueryLoggingConfig" type:"list" required:"true"`
@@ -13740,7 +13783,7 @@ func (s *ListResourceRecordSetsOutput) SetResourceRecordSets(v []*ResourceRecord
}
// A request to get a list of the reusable delegation sets that are associated
-// with the current AWS account.
+// with the current account.
type ListReusableDelegationSetsInput struct {
_ struct{} `locationName:"ListReusableDelegationSetsRequest" type:"structure"`
@@ -13785,12 +13828,12 @@ func (s *ListReusableDelegationSetsInput) SetMaxItems(v string) *ListReusableDel
}
// A complex type that contains information about the reusable delegation sets
-// that are associated with the current AWS account.
+// that are associated with the current account.
type ListReusableDelegationSetsOutput struct {
_ struct{} `type:"structure"`
// A complex type that contains one DelegationSet element for each reusable
- // delegation set that was created by the current AWS account.
+ // delegation set that was created by the current account.
//
// DelegationSets is a required field
DelegationSets []*DelegationSet `locationNameList:"DelegationSet" type:"list" required:"true"`
@@ -14043,7 +14086,7 @@ func (s *ListTagsForResourcesOutput) SetResourceTagSets(v []*ResourceTagSet) *Li
}
// A complex type that contains the information about the request to list the
-// traffic policies that are associated with the current AWS account.
+// traffic policies that are associated with the current account.
type ListTrafficPoliciesInput struct {
_ struct{} `locationName:"ListTrafficPoliciesRequest" type:"structure"`
@@ -14125,7 +14168,7 @@ type ListTrafficPoliciesOutput struct {
TrafficPolicyIdMarker *string `min:"1" type:"string" required:"true"`
// A list that contains one TrafficPolicySummary element for each traffic policy
- // that was created by the current AWS account.
+ // that was created by the current account.
//
// TrafficPolicySummaries is a required field
TrafficPolicySummaries []*TrafficPolicySummary `locationNameList:"TrafficPolicySummary" type:"list" required:"true"`
@@ -14547,7 +14590,7 @@ func (s *ListTrafficPolicyInstancesByPolicyOutput) SetTrafficPolicyInstances(v [
}
// A request to get information about the traffic policy instances that you
-// created by using the current AWS account.
+// created by using the current account.
type ListTrafficPolicyInstancesInput struct {
_ struct{} `locationName:"ListTrafficPolicyInstancesRequest" type:"structure"`
@@ -15080,9 +15123,9 @@ func (s *ResourceRecord) SetValue(v string) *ResourceRecord {
type ResourceRecordSet struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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:
@@ -15344,9 +15387,9 @@ type ResourceRecordSet struct {
// 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.
+ // 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.
@@ -15863,8 +15906,8 @@ type TestDNSAnswerInput struct {
// 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).
+ // the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia)
+ // Region (us-east-1).
ResolverIP *string `location:"querystring" locationName:"resolverip" type:"string"`
}
@@ -16243,7 +16286,7 @@ func (s *TrafficPolicyInstance) SetTrafficPolicyVersion(v int64) *TrafficPolicyI
}
// A complex type that contains information about the latest version of one
-// traffic policy that is associated with the current AWS account.
+// traffic policy that is associated with the current account.
type TrafficPolicySummary struct {
_ struct{} `type:"structure"`
@@ -16263,7 +16306,7 @@ type TrafficPolicySummary struct {
// Name is a required field
Name *string `type:"string" required:"true"`
- // The number of traffic policies that are associated with the current AWS account.
+ // The number of traffic policies that are associated with the current account.
//
// TrafficPolicyCount is a required field
TrafficPolicyCount *int64 `min:"1" type:"integer" required:"true"`
@@ -17377,6 +17420,9 @@ const (
// HealthCheckTypeCloudwatchMetric is a HealthCheckType enum value
HealthCheckTypeCloudwatchMetric = "CLOUDWATCH_METRIC"
+
+ // HealthCheckTypeRecoveryControl is a HealthCheckType enum value
+ HealthCheckTypeRecoveryControl = "RECOVERY_CONTROL"
)
// HealthCheckType_Values returns all elements of the HealthCheckType enum
@@ -17389,6 +17435,7 @@ func HealthCheckType_Values() []string {
HealthCheckTypeTcp,
HealthCheckTypeCalculated,
HealthCheckTypeCloudwatchMetric,
+ HealthCheckTypeRecoveryControl,
}
}
diff --git a/service/route53/errors.go b/service/route53/errors.go
index 9608400616..a37a804daa 100644
--- a/service/route53/errors.go
+++ b/service/route53/errors.go
@@ -162,6 +162,10 @@ const (
// 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.
ErrCodeInsufficientCloudWatchLogsResourcePolicy = "InsufficientCloudWatchLogsResourcePolicy"
// ErrCodeInvalidArgument for service response error code
@@ -283,7 +287,7 @@ const (
// To get the current limit on the number of Amazon VPCs that you can associate
// with a private hosted zone, see GetHostedZoneLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetHostedZoneLimit.html).
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
ErrCodeLimitsExceeded = "LimitsExceeded"
// ErrCodeNoSuchChange for service response error code
@@ -397,11 +401,11 @@ const (
// For information about how to get the current limit for an account, see GetAccountLimit
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
//
- // You have reached the maximum number of active health checks for an AWS account.
+ // You have reached the maximum number of active health checks for an account.
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
ErrCodeTooManyHealthChecks = "TooManyHealthChecks"
// ErrCodeTooManyHostedZones for service response error code
@@ -422,7 +426,7 @@ const (
// delegation set, see GetReusableDelegationSetLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
ErrCodeTooManyHostedZones = "TooManyHostedZones"
// ErrCodeTooManyKeySigningKeys for service response error code
@@ -444,7 +448,7 @@ const (
// To get the current limit for an account, see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
ErrCodeTooManyTrafficPolicies = "TooManyTrafficPolicies"
// ErrCodeTooManyTrafficPolicyInstances for service response error code
@@ -460,7 +464,7 @@ const (
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html).
//
// To request a higher limit, create a case (http://aws.amazon.com/route53-request)
- // with the AWS Support Center.
+ // with the Amazon Web Services Support Center.
ErrCodeTooManyTrafficPolicyInstances = "TooManyTrafficPolicyInstances"
// ErrCodeTooManyTrafficPolicyVersionsForCurrentPolicy for service response error code
diff --git a/service/route53recoverycluster/api.go b/service/route53recoverycluster/api.go
new file mode 100644
index 0000000000..b4fdd47c09
--- /dev/null
+++ b/service/route53recoverycluster/api.go
@@ -0,0 +1,1095 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycluster
+
+import (
+ "fmt"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/awsutil"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
+)
+
+const opGetRoutingControlState = "GetRoutingControlState"
+
+// GetRoutingControlStateRequest generates a "aws/request.Request" representing the
+// client's request for the GetRoutingControlState operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetRoutingControlState for more information on using the GetRoutingControlState
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetRoutingControlStateRequest method.
+// req, resp := client.GetRoutingControlStateRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/GetRoutingControlState
+func (c *Route53RecoveryCluster) GetRoutingControlStateRequest(input *GetRoutingControlStateInput) (req *request.Request, output *GetRoutingControlStateOutput) {
+ op := &request.Operation{
+ Name: opGetRoutingControlState,
+ HTTPMethod: "POST",
+ HTTPPath: "/",
+ }
+
+ if input == nil {
+ input = &GetRoutingControlStateInput{}
+ }
+
+ output = &GetRoutingControlStateOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetRoutingControlState API operation for Route53 Recovery Cluster.
+//
+// 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 (https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html).
+// 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
+// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
+// in the Route 53 Application Recovery Controller Developer Guide.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Route53 Recovery Cluster's
+// API operation GetRoutingControlState for usage and error information.
+//
+// Returned Error Types:
+// * AccessDeniedException
+// You don't have sufficient permissions to query the routing control state.
+//
+// * InternalServerException
+// There was an unexpected error during processing of the request.
+//
+// * ResourceNotFoundException
+// The request references a routing control that was not found.
+//
+// * ValidationException
+// There was a validation error on the request.
+//
+// * ThrottlingException
+// The request was denied because of request throttling.
+//
+// * EndpointTemporarilyUnavailableException
+// The cluster endpoint isn't available. Try another cluster endpoint.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/GetRoutingControlState
+func (c *Route53RecoveryCluster) GetRoutingControlState(input *GetRoutingControlStateInput) (*GetRoutingControlStateOutput, error) {
+ req, out := c.GetRoutingControlStateRequest(input)
+ return out, req.Send()
+}
+
+// GetRoutingControlStateWithContext is the same as GetRoutingControlState with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetRoutingControlState for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryCluster) GetRoutingControlStateWithContext(ctx aws.Context, input *GetRoutingControlStateInput, opts ...request.Option) (*GetRoutingControlStateOutput, error) {
+ req, out := c.GetRoutingControlStateRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateRoutingControlState = "UpdateRoutingControlState"
+
+// UpdateRoutingControlStateRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateRoutingControlState operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateRoutingControlState for more information on using the UpdateRoutingControlState
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateRoutingControlStateRequest method.
+// req, resp := client.UpdateRoutingControlStateRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState
+func (c *Route53RecoveryCluster) UpdateRoutingControlStateRequest(input *UpdateRoutingControlStateInput) (req *request.Request, output *UpdateRoutingControlStateOutput) {
+ op := &request.Operation{
+ Name: opUpdateRoutingControlState,
+ HTTPMethod: "POST",
+ HTTPPath: "/",
+ }
+
+ if input == nil {
+ input = &UpdateRoutingControlStateInput{}
+ }
+
+ output = &UpdateRoutingControlStateOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// UpdateRoutingControlState API operation for Route53 Recovery Cluster.
+//
+// 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
+// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
+// in the Route 53 Application Recovery Controller Developer Guide.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Route53 Recovery Cluster's
+// API operation UpdateRoutingControlState for usage and error information.
+//
+// Returned Error Types:
+// * AccessDeniedException
+// You don't have sufficient permissions to query the routing control state.
+//
+// * InternalServerException
+// There was an unexpected error during processing of the request.
+//
+// * ResourceNotFoundException
+// The request references a routing control that was not found.
+//
+// * ValidationException
+// There was a validation error on the request.
+//
+// * ThrottlingException
+// The request was denied because of request throttling.
+//
+// * EndpointTemporarilyUnavailableException
+// The cluster endpoint isn't available. Try another cluster endpoint.
+//
+// * ConflictException
+// There was a conflict with this request. Try again.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlState
+func (c *Route53RecoveryCluster) UpdateRoutingControlState(input *UpdateRoutingControlStateInput) (*UpdateRoutingControlStateOutput, error) {
+ req, out := c.UpdateRoutingControlStateRequest(input)
+ return out, req.Send()
+}
+
+// UpdateRoutingControlStateWithContext is the same as UpdateRoutingControlState with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateRoutingControlState for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryCluster) UpdateRoutingControlStateWithContext(ctx aws.Context, input *UpdateRoutingControlStateInput, opts ...request.Option) (*UpdateRoutingControlStateOutput, error) {
+ req, out := c.UpdateRoutingControlStateRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateRoutingControlStates = "UpdateRoutingControlStates"
+
+// UpdateRoutingControlStatesRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateRoutingControlStates operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateRoutingControlStates for more information on using the UpdateRoutingControlStates
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateRoutingControlStatesRequest method.
+// req, resp := client.UpdateRoutingControlStatesRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates
+func (c *Route53RecoveryCluster) UpdateRoutingControlStatesRequest(input *UpdateRoutingControlStatesInput) (req *request.Request, output *UpdateRoutingControlStatesOutput) {
+ op := &request.Operation{
+ Name: opUpdateRoutingControlStates,
+ HTTPMethod: "POST",
+ HTTPPath: "/",
+ }
+
+ if input == nil {
+ input = &UpdateRoutingControlStatesInput{}
+ }
+
+ output = &UpdateRoutingControlStatesOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// UpdateRoutingControlStates API operation for Route53 Recovery Cluster.
+//
+// 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
+// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html)
+// in the Route 53 Application Recovery Controller Developer Guide.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for Route53 Recovery Cluster's
+// API operation UpdateRoutingControlStates for usage and error information.
+//
+// Returned Error Types:
+// * AccessDeniedException
+// You don't have sufficient permissions to query the routing control state.
+//
+// * InternalServerException
+// There was an unexpected error during processing of the request.
+//
+// * ResourceNotFoundException
+// The request references a routing control that was not found.
+//
+// * ValidationException
+// There was a validation error on the request.
+//
+// * ThrottlingException
+// The request was denied because of request throttling.
+//
+// * EndpointTemporarilyUnavailableException
+// The cluster endpoint isn't available. Try another cluster endpoint.
+//
+// * ConflictException
+// There was a conflict with this request. Try again.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02/UpdateRoutingControlStates
+func (c *Route53RecoveryCluster) UpdateRoutingControlStates(input *UpdateRoutingControlStatesInput) (*UpdateRoutingControlStatesOutput, error) {
+ req, out := c.UpdateRoutingControlStatesRequest(input)
+ return out, req.Send()
+}
+
+// UpdateRoutingControlStatesWithContext is the same as UpdateRoutingControlStates with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateRoutingControlStates for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryCluster) UpdateRoutingControlStatesWithContext(ctx aws.Context, input *UpdateRoutingControlStatesInput, opts ...request.Option) (*UpdateRoutingControlStatesOutput, error) {
+ req, out := c.UpdateRoutingControlStatesRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// You don't have sufficient permissions to query the routing control state.
+type AccessDeniedException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s AccessDeniedException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AccessDeniedException) GoString() string {
+ return s.String()
+}
+
+func newErrorAccessDeniedException(v protocol.ResponseMetadata) error {
+ return &AccessDeniedException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *AccessDeniedException) Code() string {
+ return "AccessDeniedException"
+}
+
+// Message returns the exception's message.
+func (s *AccessDeniedException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *AccessDeniedException) OrigErr() error {
+ return nil
+}
+
+func (s *AccessDeniedException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *AccessDeniedException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *AccessDeniedException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// There was a conflict with this request. Try again.
+type ConflictException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ // Description of the ConflictException error
+ Message_ *string `locationName:"message" type:"string"`
+
+ // Identifier of the resource in use
+ //
+ // ResourceId is a required field
+ ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
+
+ // Type of the resource in use
+ //
+ // ResourceType is a required field
+ ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ConflictException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ConflictException) GoString() string {
+ return s.String()
+}
+
+func newErrorConflictException(v protocol.ResponseMetadata) error {
+ return &ConflictException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ConflictException) Code() string {
+ return "ConflictException"
+}
+
+// Message returns the exception's message.
+func (s *ConflictException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ConflictException) OrigErr() error {
+ return nil
+}
+
+func (s *ConflictException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ConflictException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ConflictException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// The cluster endpoint isn't available. Try another cluster endpoint.
+type EndpointTemporarilyUnavailableException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s EndpointTemporarilyUnavailableException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s EndpointTemporarilyUnavailableException) GoString() string {
+ return s.String()
+}
+
+func newErrorEndpointTemporarilyUnavailableException(v protocol.ResponseMetadata) error {
+ return &EndpointTemporarilyUnavailableException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *EndpointTemporarilyUnavailableException) Code() string {
+ return "EndpointTemporarilyUnavailableException"
+}
+
+// Message returns the exception's message.
+func (s *EndpointTemporarilyUnavailableException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *EndpointTemporarilyUnavailableException) OrigErr() error {
+ return nil
+}
+
+func (s *EndpointTemporarilyUnavailableException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *EndpointTemporarilyUnavailableException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *EndpointTemporarilyUnavailableException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type GetRoutingControlStateInput struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Number (ARN) for the routing control that you want to
+ // get the state for.
+ //
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetRoutingControlStateInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRoutingControlStateInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetRoutingControlStateInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetRoutingControlStateInput"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *GetRoutingControlStateInput) SetRoutingControlArn(v string) *GetRoutingControlStateInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+type GetRoutingControlStateOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Number (ARN) of the response.
+ //
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `min:"1" type:"string" required:"true"`
+
+ // The state of the routing control.
+ //
+ // RoutingControlState is a required field
+ RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
+}
+
+// String returns the string representation
+func (s GetRoutingControlStateOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRoutingControlStateOutput) GoString() string {
+ return s.String()
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *GetRoutingControlStateOutput) SetRoutingControlArn(v string) *GetRoutingControlStateOutput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// SetRoutingControlState sets the RoutingControlState field's value.
+func (s *GetRoutingControlStateOutput) SetRoutingControlState(v string) *GetRoutingControlStateOutput {
+ s.RoutingControlState = &v
+ return s
+}
+
+// There was an unexpected error during processing of the request.
+type InternalServerException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+
+ // Advice to clients on when the call can be safely retried
+ RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"`
+}
+
+// String returns the string representation
+func (s InternalServerException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s InternalServerException) GoString() string {
+ return s.String()
+}
+
+func newErrorInternalServerException(v protocol.ResponseMetadata) error {
+ return &InternalServerException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *InternalServerException) Code() string {
+ return "InternalServerException"
+}
+
+// Message returns the exception's message.
+func (s *InternalServerException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *InternalServerException) OrigErr() error {
+ return nil
+}
+
+func (s *InternalServerException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *InternalServerException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *InternalServerException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// The request references a routing control that was not found.
+type ResourceNotFoundException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+
+ // Hypothetical resource identifier that was not found
+ //
+ // ResourceId is a required field
+ ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
+
+ // Hypothetical resource type that was not found
+ //
+ // ResourceType is a required field
+ ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ResourceNotFoundException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ResourceNotFoundException) GoString() string {
+ return s.String()
+}
+
+func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
+ return &ResourceNotFoundException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ResourceNotFoundException) Code() string {
+ return "ResourceNotFoundException"
+}
+
+// Message returns the exception's message.
+func (s *ResourceNotFoundException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ResourceNotFoundException) OrigErr() error {
+ return nil
+}
+
+func (s *ResourceNotFoundException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ResourceNotFoundException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ResourceNotFoundException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// The request was denied because of request throttling.
+type ThrottlingException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+
+ // Advice to clients on when the call can be safely retried
+ RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"`
+}
+
+// String returns the string representation
+func (s ThrottlingException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ThrottlingException) GoString() string {
+ return s.String()
+}
+
+func newErrorThrottlingException(v protocol.ResponseMetadata) error {
+ return &ThrottlingException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ThrottlingException) Code() string {
+ return "ThrottlingException"
+}
+
+// Message returns the exception's message.
+func (s *ThrottlingException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ThrottlingException) OrigErr() error {
+ return nil
+}
+
+func (s *ThrottlingException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ThrottlingException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ThrottlingException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// A routing control state.
+type UpdateRoutingControlStateEntry struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Number (ARN) for the routing control state entry.
+ //
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `min:"1" type:"string" required:"true"`
+
+ // The routing control state in a set of routing control state entries.
+ //
+ // RoutingControlState is a required field
+ RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlStateEntry) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlStateEntry) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateRoutingControlStateEntry) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateRoutingControlStateEntry"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+ if s.RoutingControlState == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlState"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *UpdateRoutingControlStateEntry) SetRoutingControlArn(v string) *UpdateRoutingControlStateEntry {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// SetRoutingControlState sets the RoutingControlState field's value.
+func (s *UpdateRoutingControlStateEntry) SetRoutingControlState(v string) *UpdateRoutingControlStateEntry {
+ s.RoutingControlState = &v
+ return s
+}
+
+type UpdateRoutingControlStateInput struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Number (ARN) for the routing control that you want to
+ // update the state for.
+ //
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `min:"1" type:"string" required:"true"`
+
+ // The state of the routing control. You can set the value to be On or Off.
+ //
+ // RoutingControlState is a required field
+ RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlStateInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlStateInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateRoutingControlStateInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateRoutingControlStateInput"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+ if s.RoutingControlState == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlState"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *UpdateRoutingControlStateInput) SetRoutingControlArn(v string) *UpdateRoutingControlStateInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// SetRoutingControlState sets the RoutingControlState field's value.
+func (s *UpdateRoutingControlStateInput) SetRoutingControlState(v string) *UpdateRoutingControlStateInput {
+ s.RoutingControlState = &v
+ return s
+}
+
+type UpdateRoutingControlStateOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlStateOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlStateOutput) GoString() string {
+ return s.String()
+}
+
+type UpdateRoutingControlStatesInput struct {
+ _ struct{} `type:"structure"`
+
+ // A set of routing control entries that you want to update.
+ //
+ // UpdateRoutingControlStateEntries is a required field
+ UpdateRoutingControlStateEntries []*UpdateRoutingControlStateEntry `type:"list" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlStatesInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlStatesInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateRoutingControlStatesInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateRoutingControlStatesInput"}
+ if s.UpdateRoutingControlStateEntries == nil {
+ invalidParams.Add(request.NewErrParamRequired("UpdateRoutingControlStateEntries"))
+ }
+ if s.UpdateRoutingControlStateEntries != nil {
+ for i, v := range s.UpdateRoutingControlStateEntries {
+ if v == nil {
+ continue
+ }
+ if err := v.Validate(); err != nil {
+ invalidParams.AddNested(fmt.Sprintf("%s[%v]", "UpdateRoutingControlStateEntries", i), err.(request.ErrInvalidParams))
+ }
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetUpdateRoutingControlStateEntries sets the UpdateRoutingControlStateEntries field's value.
+func (s *UpdateRoutingControlStatesInput) SetUpdateRoutingControlStateEntries(v []*UpdateRoutingControlStateEntry) *UpdateRoutingControlStatesInput {
+ s.UpdateRoutingControlStateEntries = v
+ return s
+}
+
+type UpdateRoutingControlStatesOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlStatesOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlStatesOutput) GoString() string {
+ return s.String()
+}
+
+// There was a validation error on the request.
+type ValidationException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ // The fields that caused the error, if applicable
+ Fields []*ValidationExceptionField `locationName:"fields" type:"list"`
+
+ Message_ *string `locationName:"message" type:"string"`
+
+ // Reason the request failed validation
+ Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
+}
+
+// String returns the string representation
+func (s ValidationException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ValidationException) GoString() string {
+ return s.String()
+}
+
+func newErrorValidationException(v protocol.ResponseMetadata) error {
+ return &ValidationException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ValidationException) Code() string {
+ return "ValidationException"
+}
+
+// Message returns the exception's message.
+func (s *ValidationException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ValidationException) OrigErr() error {
+ return nil
+}
+
+func (s *ValidationException) Error() string {
+ return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ValidationException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ValidationException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// There was a validation error on the request.
+type ValidationExceptionField struct {
+ _ struct{} `type:"structure"`
+
+ // Information about the validation exception.
+ //
+ // Message is a required field
+ Message *string `locationName:"message" type:"string" required:"true"`
+
+ // The field that had the validation exception.
+ //
+ // Name is a required field
+ Name *string `locationName:"name" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ValidationExceptionField) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ValidationExceptionField) GoString() string {
+ return s.String()
+}
+
+// SetMessage sets the Message field's value.
+func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField {
+ s.Message = &v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField {
+ s.Name = &v
+ return s
+}
+
+const (
+ // RoutingControlStateOn is a RoutingControlState enum value
+ RoutingControlStateOn = "On"
+
+ // RoutingControlStateOff is a RoutingControlState enum value
+ RoutingControlStateOff = "Off"
+)
+
+// RoutingControlState_Values returns all elements of the RoutingControlState enum
+func RoutingControlState_Values() []string {
+ return []string{
+ RoutingControlStateOn,
+ RoutingControlStateOff,
+ }
+}
+
+// Reason the request failed validation
+const (
+ // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
+ ValidationExceptionReasonUnknownOperation = "unknownOperation"
+
+ // ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
+ ValidationExceptionReasonCannotParse = "cannotParse"
+
+ // ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
+ ValidationExceptionReasonFieldValidationFailed = "fieldValidationFailed"
+
+ // ValidationExceptionReasonOther is a ValidationExceptionReason enum value
+ ValidationExceptionReasonOther = "other"
+)
+
+// ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum
+func ValidationExceptionReason_Values() []string {
+ return []string{
+ ValidationExceptionReasonUnknownOperation,
+ ValidationExceptionReasonCannotParse,
+ ValidationExceptionReasonFieldValidationFailed,
+ ValidationExceptionReasonOther,
+ }
+}
diff --git a/service/route53recoverycluster/doc.go b/service/route53recoverycluster/doc.go
new file mode 100644
index 0000000000..c82bf94f87
--- /dev/null
+++ b/service/route53recoverycluster/doc.go
@@ -0,0 +1,59 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoverycluster provides the client and types for making API
+// requests to Route53 Recovery Cluster.
+//
+// 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
+// (https://docs.aws.amazon.com/recovery-cluster/latest/api/).
+//
+// * 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
+// (https://docs.aws.amazon.com/recovery-readiness/latest/api/).
+//
+// * 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
+// (r53recovery/latest/dg/).
+//
+// See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02 for more information on this service.
+//
+// See route53recoverycluster package documentation for more information.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/
+//
+// Using the Client
+//
+// To contact Route53 Recovery Cluster with the SDK use the New function to create
+// a new service client. With that client you can make API requests to the service.
+// These clients are safe to use concurrently.
+//
+// See the SDK's documentation for more information on how to use the SDK.
+// https://docs.aws.amazon.com/sdk-for-go/api/
+//
+// See aws.Config documentation for more information on configuring SDK clients.
+// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
+//
+// See the Route53 Recovery Cluster client Route53RecoveryCluster for more
+// information on creating client for this service.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycluster/#New
+package route53recoverycluster
diff --git a/service/route53recoverycluster/errors.go b/service/route53recoverycluster/errors.go
new file mode 100644
index 0000000000..e2b633bcea
--- /dev/null
+++ b/service/route53recoverycluster/errors.go
@@ -0,0 +1,62 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycluster
+
+import (
+ "github.com/aws/aws-sdk-go/private/protocol"
+)
+
+const (
+
+ // ErrCodeAccessDeniedException for service response error code
+ // "AccessDeniedException".
+ //
+ // You don't have sufficient permissions to query the routing control state.
+ ErrCodeAccessDeniedException = "AccessDeniedException"
+
+ // ErrCodeConflictException for service response error code
+ // "ConflictException".
+ //
+ // There was a conflict with this request. Try again.
+ ErrCodeConflictException = "ConflictException"
+
+ // ErrCodeEndpointTemporarilyUnavailableException for service response error code
+ // "EndpointTemporarilyUnavailableException".
+ //
+ // The cluster endpoint isn't available. Try another cluster endpoint.
+ ErrCodeEndpointTemporarilyUnavailableException = "EndpointTemporarilyUnavailableException"
+
+ // ErrCodeInternalServerException for service response error code
+ // "InternalServerException".
+ //
+ // There was an unexpected error during processing of the request.
+ ErrCodeInternalServerException = "InternalServerException"
+
+ // ErrCodeResourceNotFoundException for service response error code
+ // "ResourceNotFoundException".
+ //
+ // The request references a routing control that was not found.
+ ErrCodeResourceNotFoundException = "ResourceNotFoundException"
+
+ // ErrCodeThrottlingException for service response error code
+ // "ThrottlingException".
+ //
+ // The request was denied because of request throttling.
+ ErrCodeThrottlingException = "ThrottlingException"
+
+ // ErrCodeValidationException for service response error code
+ // "ValidationException".
+ //
+ // There was a validation error on the request.
+ ErrCodeValidationException = "ValidationException"
+)
+
+var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{
+ "AccessDeniedException": newErrorAccessDeniedException,
+ "ConflictException": newErrorConflictException,
+ "EndpointTemporarilyUnavailableException": newErrorEndpointTemporarilyUnavailableException,
+ "InternalServerException": newErrorInternalServerException,
+ "ResourceNotFoundException": newErrorResourceNotFoundException,
+ "ThrottlingException": newErrorThrottlingException,
+ "ValidationException": newErrorValidationException,
+}
diff --git a/service/route53recoverycluster/route53recoveryclusteriface/interface.go b/service/route53recoverycluster/route53recoveryclusteriface/interface.go
new file mode 100644
index 0000000000..cd36871730
--- /dev/null
+++ b/service/route53recoverycluster/route53recoveryclusteriface/interface.go
@@ -0,0 +1,76 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoveryclusteriface provides an interface to enable mocking the Route53 Recovery Cluster service client
+// for testing your code.
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters.
+package route53recoveryclusteriface
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/service/route53recoverycluster"
+)
+
+// Route53RecoveryClusterAPI provides an interface to enable mocking the
+// route53recoverycluster.Route53RecoveryCluster service client's API operation,
+// paginators, and waiters. This make unit testing your code that calls out
+// to the SDK's service client's calls easier.
+//
+// The best way to use this interface is so the SDK's service client's calls
+// can be stubbed out for unit testing your code with the SDK without needing
+// to inject custom request handlers into the SDK's request pipeline.
+//
+// // myFunc uses an SDK service client to make a request to
+// // Route53 Recovery Cluster.
+// func myFunc(svc route53recoveryclusteriface.Route53RecoveryClusterAPI) bool {
+// // Make svc.GetRoutingControlState request
+// }
+//
+// func main() {
+// sess := session.New()
+// svc := route53recoverycluster.New(sess)
+//
+// myFunc(svc)
+// }
+//
+// In your _test.go file:
+//
+// // Define a mock struct to be used in your unit tests of myFunc.
+// type mockRoute53RecoveryClusterClient struct {
+// route53recoveryclusteriface.Route53RecoveryClusterAPI
+// }
+// func (m *mockRoute53RecoveryClusterClient) GetRoutingControlState(input *route53recoverycluster.GetRoutingControlStateInput) (*route53recoverycluster.GetRoutingControlStateOutput, error) {
+// // mock response/functionality
+// }
+//
+// func TestMyFunc(t *testing.T) {
+// // Setup Test
+// mockSvc := &mockRoute53RecoveryClusterClient{}
+//
+// myfunc(mockSvc)
+//
+// // Verify myFunc's functionality
+// }
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters. Its suggested to use the pattern above for testing, or using
+// tooling to generate mocks to satisfy the interfaces.
+type Route53RecoveryClusterAPI interface {
+ GetRoutingControlState(*route53recoverycluster.GetRoutingControlStateInput) (*route53recoverycluster.GetRoutingControlStateOutput, error)
+ GetRoutingControlStateWithContext(aws.Context, *route53recoverycluster.GetRoutingControlStateInput, ...request.Option) (*route53recoverycluster.GetRoutingControlStateOutput, error)
+ GetRoutingControlStateRequest(*route53recoverycluster.GetRoutingControlStateInput) (*request.Request, *route53recoverycluster.GetRoutingControlStateOutput)
+
+ UpdateRoutingControlState(*route53recoverycluster.UpdateRoutingControlStateInput) (*route53recoverycluster.UpdateRoutingControlStateOutput, error)
+ UpdateRoutingControlStateWithContext(aws.Context, *route53recoverycluster.UpdateRoutingControlStateInput, ...request.Option) (*route53recoverycluster.UpdateRoutingControlStateOutput, error)
+ UpdateRoutingControlStateRequest(*route53recoverycluster.UpdateRoutingControlStateInput) (*request.Request, *route53recoverycluster.UpdateRoutingControlStateOutput)
+
+ UpdateRoutingControlStates(*route53recoverycluster.UpdateRoutingControlStatesInput) (*route53recoverycluster.UpdateRoutingControlStatesOutput, error)
+ UpdateRoutingControlStatesWithContext(aws.Context, *route53recoverycluster.UpdateRoutingControlStatesInput, ...request.Option) (*route53recoverycluster.UpdateRoutingControlStatesOutput, error)
+ UpdateRoutingControlStatesRequest(*route53recoverycluster.UpdateRoutingControlStatesInput) (*request.Request, *route53recoverycluster.UpdateRoutingControlStatesOutput)
+}
+
+var _ Route53RecoveryClusterAPI = (*route53recoverycluster.Route53RecoveryCluster)(nil)
diff --git a/service/route53recoverycluster/service.go b/service/route53recoverycluster/service.go
new file mode 100644
index 0000000000..bcf7ecb7ff
--- /dev/null
+++ b/service/route53recoverycluster/service.go
@@ -0,0 +1,106 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycluster
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/client"
+ "github.com/aws/aws-sdk-go/aws/client/metadata"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/aws/signer/v4"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
+)
+
+// Route53RecoveryCluster provides the API operation methods for making requests to
+// Route53 Recovery Cluster. See this package's package overview docs
+// for details on the service.
+//
+// Route53RecoveryCluster methods are safe to use concurrently. It is not safe to
+// modify mutate any of the struct's properties though.
+type Route53RecoveryCluster struct {
+ *client.Client
+}
+
+// Used for custom client initialization logic
+var initClient func(*client.Client)
+
+// Used for custom request initialization logic
+var initRequest func(*request.Request)
+
+// Service information constants
+const (
+ ServiceName = "Route53 Recovery Cluster" // Name of service.
+ EndpointsID = "route53-recovery-cluster" // ID to lookup a service endpoint with.
+ ServiceID = "Route53 Recovery Cluster" // ServiceID is a unique identifier of a specific service.
+)
+
+// New creates a new instance of the Route53RecoveryCluster client with a session.
+// If additional configuration is needed for the client instance use the optional
+// aws.Config parameter to add your extra config.
+//
+// Example:
+// mySession := session.Must(session.NewSession())
+//
+// // Create a Route53RecoveryCluster client from just a session.
+// svc := route53recoverycluster.New(mySession)
+//
+// // Create a Route53RecoveryCluster client with additional configuration
+// svc := route53recoverycluster.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
+func New(p client.ConfigProvider, cfgs ...*aws.Config) *Route53RecoveryCluster {
+ c := p.ClientConfig(EndpointsID, cfgs...)
+ if c.SigningNameDerived || len(c.SigningName) == 0 {
+ c.SigningName = "route53-recovery-cluster"
+ }
+ return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName)
+}
+
+// newClient creates, initializes and returns a new service client instance.
+func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *Route53RecoveryCluster {
+ svc := &Route53RecoveryCluster{
+ Client: client.New(
+ cfg,
+ metadata.ClientInfo{
+ ServiceName: ServiceName,
+ ServiceID: ServiceID,
+ SigningName: signingName,
+ SigningRegion: signingRegion,
+ PartitionID: partitionID,
+ Endpoint: endpoint,
+ APIVersion: "2019-12-02",
+ JSONVersion: "1.0",
+ TargetPrefix: "ToggleCustomerAPI",
+ },
+ handlers,
+ ),
+ }
+
+ // Handlers
+ svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler)
+ svc.Handlers.Build.PushBackNamed(jsonrpc.BuildHandler)
+ svc.Handlers.Unmarshal.PushBackNamed(jsonrpc.UnmarshalHandler)
+ svc.Handlers.UnmarshalMeta.PushBackNamed(jsonrpc.UnmarshalMetaHandler)
+ svc.Handlers.UnmarshalError.PushBackNamed(
+ protocol.NewUnmarshalErrorHandler(jsonrpc.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(),
+ )
+
+ // Run custom client initialization if present
+ if initClient != nil {
+ initClient(svc.Client)
+ }
+
+ return svc
+}
+
+// newRequest creates a new request for a Route53RecoveryCluster operation and runs any
+// custom request initialization.
+func (c *Route53RecoveryCluster) newRequest(op *request.Operation, params, data interface{}) *request.Request {
+ req := c.NewRequest(op, params, data)
+
+ // Run custom request initialization if present
+ if initRequest != nil {
+ initRequest(req)
+ }
+
+ return req
+}
diff --git a/service/route53recoverycontrolconfig/api.go b/service/route53recoverycontrolconfig/api.go
new file mode 100644
index 0000000000..bca1c74718
--- /dev/null
+++ b/service/route53recoverycontrolconfig/api.go
@@ -0,0 +1,5185 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycontrolconfig
+
+import (
+ "fmt"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/awsutil"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/restjson"
+)
+
+const opCreateCluster = "CreateCluster"
+
+// CreateClusterRequest generates a "aws/request.Request" representing the
+// client's request for the CreateCluster operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateCluster for more information on using the CreateCluster
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateClusterRequest method.
+// req, resp := client.CreateClusterRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateCluster
+func (c *Route53RecoveryControlConfig) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput) {
+ op := &request.Operation{
+ Name: opCreateCluster,
+ HTTPMethod: "POST",
+ HTTPPath: "/cluster",
+ }
+
+ if input == nil {
+ input = &CreateClusterInput{}
+ }
+
+ output = &CreateClusterOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateCluster API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation CreateCluster for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * ServiceQuotaExceededException
+// 402 response
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateCluster
+func (c *Route53RecoveryControlConfig) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error) {
+ req, out := c.CreateClusterRequest(input)
+ return out, req.Send()
+}
+
+// CreateClusterWithContext is the same as CreateCluster with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateCluster for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error) {
+ req, out := c.CreateClusterRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateControlPanel = "CreateControlPanel"
+
+// CreateControlPanelRequest generates a "aws/request.Request" representing the
+// client's request for the CreateControlPanel operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateControlPanel for more information on using the CreateControlPanel
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateControlPanelRequest method.
+// req, resp := client.CreateControlPanelRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateControlPanel
+func (c *Route53RecoveryControlConfig) CreateControlPanelRequest(input *CreateControlPanelInput) (req *request.Request, output *CreateControlPanelOutput) {
+ op := &request.Operation{
+ Name: opCreateControlPanel,
+ HTTPMethod: "POST",
+ HTTPPath: "/controlpanel",
+ }
+
+ if input == nil {
+ input = &CreateControlPanelInput{}
+ }
+
+ output = &CreateControlPanelOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateControlPanel API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation CreateControlPanel for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * ServiceQuotaExceededException
+// 402 response
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateControlPanel
+func (c *Route53RecoveryControlConfig) CreateControlPanel(input *CreateControlPanelInput) (*CreateControlPanelOutput, error) {
+ req, out := c.CreateControlPanelRequest(input)
+ return out, req.Send()
+}
+
+// CreateControlPanelWithContext is the same as CreateControlPanel with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateControlPanel for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) CreateControlPanelWithContext(ctx aws.Context, input *CreateControlPanelInput, opts ...request.Option) (*CreateControlPanelOutput, error) {
+ req, out := c.CreateControlPanelRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateRoutingControl = "CreateRoutingControl"
+
+// CreateRoutingControlRequest generates a "aws/request.Request" representing the
+// client's request for the CreateRoutingControl operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateRoutingControl for more information on using the CreateRoutingControl
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateRoutingControlRequest method.
+// req, resp := client.CreateRoutingControlRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateRoutingControl
+func (c *Route53RecoveryControlConfig) CreateRoutingControlRequest(input *CreateRoutingControlInput) (req *request.Request, output *CreateRoutingControlOutput) {
+ op := &request.Operation{
+ Name: opCreateRoutingControl,
+ HTTPMethod: "POST",
+ HTTPPath: "/routingcontrol",
+ }
+
+ if input == nil {
+ input = &CreateRoutingControlInput{}
+ }
+
+ output = &CreateRoutingControlOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateRoutingControl API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation CreateRoutingControl for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * ServiceQuotaExceededException
+// 402 response
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateRoutingControl
+func (c *Route53RecoveryControlConfig) CreateRoutingControl(input *CreateRoutingControlInput) (*CreateRoutingControlOutput, error) {
+ req, out := c.CreateRoutingControlRequest(input)
+ return out, req.Send()
+}
+
+// CreateRoutingControlWithContext is the same as CreateRoutingControl with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateRoutingControl for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) CreateRoutingControlWithContext(ctx aws.Context, input *CreateRoutingControlInput, opts ...request.Option) (*CreateRoutingControlOutput, error) {
+ req, out := c.CreateRoutingControlRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateSafetyRule = "CreateSafetyRule"
+
+// CreateSafetyRuleRequest generates a "aws/request.Request" representing the
+// client's request for the CreateSafetyRule operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateSafetyRule for more information on using the CreateSafetyRule
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateSafetyRuleRequest method.
+// req, resp := client.CreateSafetyRuleRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateSafetyRule
+func (c *Route53RecoveryControlConfig) CreateSafetyRuleRequest(input *CreateSafetyRuleInput) (req *request.Request, output *CreateSafetyRuleOutput) {
+ op := &request.Operation{
+ Name: opCreateSafetyRule,
+ HTTPMethod: "POST",
+ HTTPPath: "/safetyrule",
+ }
+
+ if input == nil {
+ input = &CreateSafetyRuleInput{}
+ }
+
+ output = &CreateSafetyRuleOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateSafetyRule API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation CreateSafetyRule for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/CreateSafetyRule
+func (c *Route53RecoveryControlConfig) CreateSafetyRule(input *CreateSafetyRuleInput) (*CreateSafetyRuleOutput, error) {
+ req, out := c.CreateSafetyRuleRequest(input)
+ return out, req.Send()
+}
+
+// CreateSafetyRuleWithContext is the same as CreateSafetyRule with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateSafetyRule for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) CreateSafetyRuleWithContext(ctx aws.Context, input *CreateSafetyRuleInput, opts ...request.Option) (*CreateSafetyRuleOutput, error) {
+ req, out := c.CreateSafetyRuleRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteCluster = "DeleteCluster"
+
+// DeleteClusterRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteCluster operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteCluster for more information on using the DeleteCluster
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteClusterRequest method.
+// req, resp := client.DeleteClusterRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteCluster
+func (c *Route53RecoveryControlConfig) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput) {
+ op := &request.Operation{
+ Name: opDeleteCluster,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/cluster/{ClusterArn}",
+ }
+
+ if input == nil {
+ input = &DeleteClusterInput{}
+ }
+
+ output = &DeleteClusterOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteCluster API operation for AWS Route53 Recovery Control Config.
+//
+// Delete a cluster.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DeleteCluster for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteCluster
+func (c *Route53RecoveryControlConfig) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error) {
+ req, out := c.DeleteClusterRequest(input)
+ return out, req.Send()
+}
+
+// DeleteClusterWithContext is the same as DeleteCluster with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteCluster for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error) {
+ req, out := c.DeleteClusterRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteControlPanel = "DeleteControlPanel"
+
+// DeleteControlPanelRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteControlPanel operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteControlPanel for more information on using the DeleteControlPanel
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteControlPanelRequest method.
+// req, resp := client.DeleteControlPanelRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteControlPanel
+func (c *Route53RecoveryControlConfig) DeleteControlPanelRequest(input *DeleteControlPanelInput) (req *request.Request, output *DeleteControlPanelOutput) {
+ op := &request.Operation{
+ Name: opDeleteControlPanel,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/controlpanel/{ControlPanelArn}",
+ }
+
+ if input == nil {
+ input = &DeleteControlPanelInput{}
+ }
+
+ output = &DeleteControlPanelOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteControlPanel API operation for AWS Route53 Recovery Control Config.
+//
+// Deletes a control panel.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DeleteControlPanel for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteControlPanel
+func (c *Route53RecoveryControlConfig) DeleteControlPanel(input *DeleteControlPanelInput) (*DeleteControlPanelOutput, error) {
+ req, out := c.DeleteControlPanelRequest(input)
+ return out, req.Send()
+}
+
+// DeleteControlPanelWithContext is the same as DeleteControlPanel with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteControlPanel for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DeleteControlPanelWithContext(ctx aws.Context, input *DeleteControlPanelInput, opts ...request.Option) (*DeleteControlPanelOutput, error) {
+ req, out := c.DeleteControlPanelRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteRoutingControl = "DeleteRoutingControl"
+
+// DeleteRoutingControlRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteRoutingControl operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteRoutingControl for more information on using the DeleteRoutingControl
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteRoutingControlRequest method.
+// req, resp := client.DeleteRoutingControlRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteRoutingControl
+func (c *Route53RecoveryControlConfig) DeleteRoutingControlRequest(input *DeleteRoutingControlInput) (req *request.Request, output *DeleteRoutingControlOutput) {
+ op := &request.Operation{
+ Name: opDeleteRoutingControl,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/routingcontrol/{RoutingControlArn}",
+ }
+
+ if input == nil {
+ input = &DeleteRoutingControlInput{}
+ }
+
+ output = &DeleteRoutingControlOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteRoutingControl API operation for AWS Route53 Recovery Control Config.
+//
+// Deletes a routing control.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DeleteRoutingControl for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteRoutingControl
+func (c *Route53RecoveryControlConfig) DeleteRoutingControl(input *DeleteRoutingControlInput) (*DeleteRoutingControlOutput, error) {
+ req, out := c.DeleteRoutingControlRequest(input)
+ return out, req.Send()
+}
+
+// DeleteRoutingControlWithContext is the same as DeleteRoutingControl with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteRoutingControl for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DeleteRoutingControlWithContext(ctx aws.Context, input *DeleteRoutingControlInput, opts ...request.Option) (*DeleteRoutingControlOutput, error) {
+ req, out := c.DeleteRoutingControlRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteSafetyRule = "DeleteSafetyRule"
+
+// DeleteSafetyRuleRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteSafetyRule operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteSafetyRule for more information on using the DeleteSafetyRule
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteSafetyRuleRequest method.
+// req, resp := client.DeleteSafetyRuleRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteSafetyRule
+func (c *Route53RecoveryControlConfig) DeleteSafetyRuleRequest(input *DeleteSafetyRuleInput) (req *request.Request, output *DeleteSafetyRuleOutput) {
+ op := &request.Operation{
+ Name: opDeleteSafetyRule,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/safetyrule/{SafetyRuleArn}",
+ }
+
+ if input == nil {
+ input = &DeleteSafetyRuleInput{}
+ }
+
+ output = &DeleteSafetyRuleOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteSafetyRule API operation for AWS Route53 Recovery Control Config.
+//
+// Deletes a safety rule.
+// />
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DeleteSafetyRule for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DeleteSafetyRule
+func (c *Route53RecoveryControlConfig) DeleteSafetyRule(input *DeleteSafetyRuleInput) (*DeleteSafetyRuleOutput, error) {
+ req, out := c.DeleteSafetyRuleRequest(input)
+ return out, req.Send()
+}
+
+// DeleteSafetyRuleWithContext is the same as DeleteSafetyRule with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteSafetyRule for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DeleteSafetyRuleWithContext(ctx aws.Context, input *DeleteSafetyRuleInput, opts ...request.Option) (*DeleteSafetyRuleOutput, error) {
+ req, out := c.DeleteSafetyRuleRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDescribeCluster = "DescribeCluster"
+
+// DescribeClusterRequest generates a "aws/request.Request" representing the
+// client's request for the DescribeCluster operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DescribeCluster for more information on using the DescribeCluster
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DescribeClusterRequest method.
+// req, resp := client.DescribeClusterRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeCluster
+func (c *Route53RecoveryControlConfig) DescribeClusterRequest(input *DescribeClusterInput) (req *request.Request, output *DescribeClusterOutput) {
+ op := &request.Operation{
+ Name: opDescribeCluster,
+ HTTPMethod: "GET",
+ HTTPPath: "/cluster/{ClusterArn}",
+ }
+
+ if input == nil {
+ input = &DescribeClusterInput{}
+ }
+
+ output = &DescribeClusterOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// DescribeCluster API operation for AWS Route53 Recovery Control Config.
+//
+// Display the details about a cluster. The response includes the cluster name,
+// endpoints, status, and Amazon Resource Name (ARN).
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DescribeCluster for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeCluster
+func (c *Route53RecoveryControlConfig) DescribeCluster(input *DescribeClusterInput) (*DescribeClusterOutput, error) {
+ req, out := c.DescribeClusterRequest(input)
+ return out, req.Send()
+}
+
+// DescribeClusterWithContext is the same as DescribeCluster with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DescribeCluster for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DescribeClusterWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.Option) (*DescribeClusterOutput, error) {
+ req, out := c.DescribeClusterRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDescribeControlPanel = "DescribeControlPanel"
+
+// DescribeControlPanelRequest generates a "aws/request.Request" representing the
+// client's request for the DescribeControlPanel operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DescribeControlPanel for more information on using the DescribeControlPanel
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DescribeControlPanelRequest method.
+// req, resp := client.DescribeControlPanelRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeControlPanel
+func (c *Route53RecoveryControlConfig) DescribeControlPanelRequest(input *DescribeControlPanelInput) (req *request.Request, output *DescribeControlPanelOutput) {
+ op := &request.Operation{
+ Name: opDescribeControlPanel,
+ HTTPMethod: "GET",
+ HTTPPath: "/controlpanel/{ControlPanelArn}",
+ }
+
+ if input == nil {
+ input = &DescribeControlPanelInput{}
+ }
+
+ output = &DescribeControlPanelOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// DescribeControlPanel API operation for AWS Route53 Recovery Control Config.
+//
+// Displays details about a control panel.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DescribeControlPanel for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeControlPanel
+func (c *Route53RecoveryControlConfig) DescribeControlPanel(input *DescribeControlPanelInput) (*DescribeControlPanelOutput, error) {
+ req, out := c.DescribeControlPanelRequest(input)
+ return out, req.Send()
+}
+
+// DescribeControlPanelWithContext is the same as DescribeControlPanel with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DescribeControlPanel for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DescribeControlPanelWithContext(ctx aws.Context, input *DescribeControlPanelInput, opts ...request.Option) (*DescribeControlPanelOutput, error) {
+ req, out := c.DescribeControlPanelRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDescribeRoutingControl = "DescribeRoutingControl"
+
+// DescribeRoutingControlRequest generates a "aws/request.Request" representing the
+// client's request for the DescribeRoutingControl operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DescribeRoutingControl for more information on using the DescribeRoutingControl
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DescribeRoutingControlRequest method.
+// req, resp := client.DescribeRoutingControlRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeRoutingControl
+func (c *Route53RecoveryControlConfig) DescribeRoutingControlRequest(input *DescribeRoutingControlInput) (req *request.Request, output *DescribeRoutingControlOutput) {
+ op := &request.Operation{
+ Name: opDescribeRoutingControl,
+ HTTPMethod: "GET",
+ HTTPPath: "/routingcontrol/{RoutingControlArn}",
+ }
+
+ if input == nil {
+ input = &DescribeRoutingControlInput{}
+ }
+
+ output = &DescribeRoutingControlOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// DescribeRoutingControl API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DescribeRoutingControl for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeRoutingControl
+func (c *Route53RecoveryControlConfig) DescribeRoutingControl(input *DescribeRoutingControlInput) (*DescribeRoutingControlOutput, error) {
+ req, out := c.DescribeRoutingControlRequest(input)
+ return out, req.Send()
+}
+
+// DescribeRoutingControlWithContext is the same as DescribeRoutingControl with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DescribeRoutingControl for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DescribeRoutingControlWithContext(ctx aws.Context, input *DescribeRoutingControlInput, opts ...request.Option) (*DescribeRoutingControlOutput, error) {
+ req, out := c.DescribeRoutingControlRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDescribeSafetyRule = "DescribeSafetyRule"
+
+// DescribeSafetyRuleRequest generates a "aws/request.Request" representing the
+// client's request for the DescribeSafetyRule operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DescribeSafetyRule for more information on using the DescribeSafetyRule
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DescribeSafetyRuleRequest method.
+// req, resp := client.DescribeSafetyRuleRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeSafetyRule
+func (c *Route53RecoveryControlConfig) DescribeSafetyRuleRequest(input *DescribeSafetyRuleInput) (req *request.Request, output *DescribeSafetyRuleOutput) {
+ op := &request.Operation{
+ Name: opDescribeSafetyRule,
+ HTTPMethod: "GET",
+ HTTPPath: "/safetyrule/{SafetyRuleArn}",
+ }
+
+ if input == nil {
+ input = &DescribeSafetyRuleInput{}
+ }
+
+ output = &DescribeSafetyRuleOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// DescribeSafetyRule API operation for AWS Route53 Recovery Control Config.
+//
+// Describes the safety rules (that is, the assertion rules and gating rules)
+// for the routing controls in a control panel.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation DescribeSafetyRule for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/DescribeSafetyRule
+func (c *Route53RecoveryControlConfig) DescribeSafetyRule(input *DescribeSafetyRuleInput) (*DescribeSafetyRuleOutput, error) {
+ req, out := c.DescribeSafetyRuleRequest(input)
+ return out, req.Send()
+}
+
+// DescribeSafetyRuleWithContext is the same as DescribeSafetyRule with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DescribeSafetyRule for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) DescribeSafetyRuleWithContext(ctx aws.Context, input *DescribeSafetyRuleInput, opts ...request.Option) (*DescribeSafetyRuleOutput, error) {
+ req, out := c.DescribeSafetyRuleRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opListAssociatedRoute53HealthChecks = "ListAssociatedRoute53HealthChecks"
+
+// ListAssociatedRoute53HealthChecksRequest generates a "aws/request.Request" representing the
+// client's request for the ListAssociatedRoute53HealthChecks operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListAssociatedRoute53HealthChecks for more information on using the ListAssociatedRoute53HealthChecks
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListAssociatedRoute53HealthChecksRequest method.
+// req, resp := client.ListAssociatedRoute53HealthChecksRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListAssociatedRoute53HealthChecks
+func (c *Route53RecoveryControlConfig) ListAssociatedRoute53HealthChecksRequest(input *ListAssociatedRoute53HealthChecksInput) (req *request.Request, output *ListAssociatedRoute53HealthChecksOutput) {
+ op := &request.Operation{
+ Name: opListAssociatedRoute53HealthChecks,
+ HTTPMethod: "GET",
+ HTTPPath: "/routingcontrol/{RoutingControlArn}/associatedRoute53HealthChecks",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListAssociatedRoute53HealthChecksInput{}
+ }
+
+ output = &ListAssociatedRoute53HealthChecksOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListAssociatedRoute53HealthChecks API operation for AWS Route53 Recovery Control Config.
+//
+// Returns an array of all Amazon Route 53 health checks associated with a specific
+// routing control.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation ListAssociatedRoute53HealthChecks for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListAssociatedRoute53HealthChecks
+func (c *Route53RecoveryControlConfig) ListAssociatedRoute53HealthChecks(input *ListAssociatedRoute53HealthChecksInput) (*ListAssociatedRoute53HealthChecksOutput, error) {
+ req, out := c.ListAssociatedRoute53HealthChecksRequest(input)
+ return out, req.Send()
+}
+
+// ListAssociatedRoute53HealthChecksWithContext is the same as ListAssociatedRoute53HealthChecks with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListAssociatedRoute53HealthChecks for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListAssociatedRoute53HealthChecksWithContext(ctx aws.Context, input *ListAssociatedRoute53HealthChecksInput, opts ...request.Option) (*ListAssociatedRoute53HealthChecksOutput, error) {
+ req, out := c.ListAssociatedRoute53HealthChecksRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListAssociatedRoute53HealthChecksPages iterates over the pages of a ListAssociatedRoute53HealthChecks operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListAssociatedRoute53HealthChecks method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListAssociatedRoute53HealthChecks operation.
+// pageNum := 0
+// err := client.ListAssociatedRoute53HealthChecksPages(params,
+// func(page *route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryControlConfig) ListAssociatedRoute53HealthChecksPages(input *ListAssociatedRoute53HealthChecksInput, fn func(*ListAssociatedRoute53HealthChecksOutput, bool) bool) error {
+ return c.ListAssociatedRoute53HealthChecksPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListAssociatedRoute53HealthChecksPagesWithContext same as ListAssociatedRoute53HealthChecksPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListAssociatedRoute53HealthChecksPagesWithContext(ctx aws.Context, input *ListAssociatedRoute53HealthChecksInput, fn func(*ListAssociatedRoute53HealthChecksOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListAssociatedRoute53HealthChecksInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListAssociatedRoute53HealthChecksRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListAssociatedRoute53HealthChecksOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListClusters = "ListClusters"
+
+// ListClustersRequest generates a "aws/request.Request" representing the
+// client's request for the ListClusters operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListClusters for more information on using the ListClusters
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListClustersRequest method.
+// req, resp := client.ListClustersRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListClusters
+func (c *Route53RecoveryControlConfig) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput) {
+ op := &request.Operation{
+ Name: opListClusters,
+ HTTPMethod: "GET",
+ HTTPPath: "/cluster",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListClustersInput{}
+ }
+
+ output = &ListClustersOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListClusters API operation for AWS Route53 Recovery Control Config.
+//
+// Returns an array of all the clusters in an account.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation ListClusters for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListClusters
+func (c *Route53RecoveryControlConfig) ListClusters(input *ListClustersInput) (*ListClustersOutput, error) {
+ req, out := c.ListClustersRequest(input)
+ return out, req.Send()
+}
+
+// ListClustersWithContext is the same as ListClusters with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListClusters for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error) {
+ req, out := c.ListClustersRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListClustersPages iterates over the pages of a ListClusters operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListClusters method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListClusters operation.
+// pageNum := 0
+// err := client.ListClustersPages(params,
+// func(page *route53recoverycontrolconfig.ListClustersOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryControlConfig) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error {
+ return c.ListClustersPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListClustersPagesWithContext same as ListClustersPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListClustersInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListClustersRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListClustersOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListControlPanels = "ListControlPanels"
+
+// ListControlPanelsRequest generates a "aws/request.Request" representing the
+// client's request for the ListControlPanels operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListControlPanels for more information on using the ListControlPanels
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListControlPanelsRequest method.
+// req, resp := client.ListControlPanelsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListControlPanels
+func (c *Route53RecoveryControlConfig) ListControlPanelsRequest(input *ListControlPanelsInput) (req *request.Request, output *ListControlPanelsOutput) {
+ op := &request.Operation{
+ Name: opListControlPanels,
+ HTTPMethod: "GET",
+ HTTPPath: "/controlpanels",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListControlPanelsInput{}
+ }
+
+ output = &ListControlPanelsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListControlPanels API operation for AWS Route53 Recovery Control Config.
+//
+// Returns an array of control panels for a cluster.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation ListControlPanels for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListControlPanels
+func (c *Route53RecoveryControlConfig) ListControlPanels(input *ListControlPanelsInput) (*ListControlPanelsOutput, error) {
+ req, out := c.ListControlPanelsRequest(input)
+ return out, req.Send()
+}
+
+// ListControlPanelsWithContext is the same as ListControlPanels with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListControlPanels for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListControlPanelsWithContext(ctx aws.Context, input *ListControlPanelsInput, opts ...request.Option) (*ListControlPanelsOutput, error) {
+ req, out := c.ListControlPanelsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListControlPanelsPages iterates over the pages of a ListControlPanels operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListControlPanels method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListControlPanels operation.
+// pageNum := 0
+// err := client.ListControlPanelsPages(params,
+// func(page *route53recoverycontrolconfig.ListControlPanelsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryControlConfig) ListControlPanelsPages(input *ListControlPanelsInput, fn func(*ListControlPanelsOutput, bool) bool) error {
+ return c.ListControlPanelsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListControlPanelsPagesWithContext same as ListControlPanelsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListControlPanelsPagesWithContext(ctx aws.Context, input *ListControlPanelsInput, fn func(*ListControlPanelsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListControlPanelsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListControlPanelsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListControlPanelsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListRoutingControls = "ListRoutingControls"
+
+// ListRoutingControlsRequest generates a "aws/request.Request" representing the
+// client's request for the ListRoutingControls operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListRoutingControls for more information on using the ListRoutingControls
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListRoutingControlsRequest method.
+// req, resp := client.ListRoutingControlsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListRoutingControls
+func (c *Route53RecoveryControlConfig) ListRoutingControlsRequest(input *ListRoutingControlsInput) (req *request.Request, output *ListRoutingControlsOutput) {
+ op := &request.Operation{
+ Name: opListRoutingControls,
+ HTTPMethod: "GET",
+ HTTPPath: "/controlpanel/{ControlPanelArn}/routingcontrols",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListRoutingControlsInput{}
+ }
+
+ output = &ListRoutingControlsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListRoutingControls API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation ListRoutingControls for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListRoutingControls
+func (c *Route53RecoveryControlConfig) ListRoutingControls(input *ListRoutingControlsInput) (*ListRoutingControlsOutput, error) {
+ req, out := c.ListRoutingControlsRequest(input)
+ return out, req.Send()
+}
+
+// ListRoutingControlsWithContext is the same as ListRoutingControls with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListRoutingControls for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListRoutingControlsWithContext(ctx aws.Context, input *ListRoutingControlsInput, opts ...request.Option) (*ListRoutingControlsOutput, error) {
+ req, out := c.ListRoutingControlsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListRoutingControlsPages iterates over the pages of a ListRoutingControls operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListRoutingControls method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListRoutingControls operation.
+// pageNum := 0
+// err := client.ListRoutingControlsPages(params,
+// func(page *route53recoverycontrolconfig.ListRoutingControlsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryControlConfig) ListRoutingControlsPages(input *ListRoutingControlsInput, fn func(*ListRoutingControlsOutput, bool) bool) error {
+ return c.ListRoutingControlsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListRoutingControlsPagesWithContext same as ListRoutingControlsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListRoutingControlsPagesWithContext(ctx aws.Context, input *ListRoutingControlsInput, fn func(*ListRoutingControlsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListRoutingControlsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListRoutingControlsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListRoutingControlsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListSafetyRules = "ListSafetyRules"
+
+// ListSafetyRulesRequest generates a "aws/request.Request" representing the
+// client's request for the ListSafetyRules operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListSafetyRules for more information on using the ListSafetyRules
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListSafetyRulesRequest method.
+// req, resp := client.ListSafetyRulesRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListSafetyRules
+func (c *Route53RecoveryControlConfig) ListSafetyRulesRequest(input *ListSafetyRulesInput) (req *request.Request, output *ListSafetyRulesOutput) {
+ op := &request.Operation{
+ Name: opListSafetyRules,
+ HTTPMethod: "GET",
+ HTTPPath: "/controlpanel/{ControlPanelArn}/safetyrules",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListSafetyRulesInput{}
+ }
+
+ output = &ListSafetyRulesOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListSafetyRules API operation for AWS Route53 Recovery Control Config.
+//
+// List the safety rules (the assertion rules and gating rules) that you've
+// defined for the routing controls in a control panel.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation ListSafetyRules for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/ListSafetyRules
+func (c *Route53RecoveryControlConfig) ListSafetyRules(input *ListSafetyRulesInput) (*ListSafetyRulesOutput, error) {
+ req, out := c.ListSafetyRulesRequest(input)
+ return out, req.Send()
+}
+
+// ListSafetyRulesWithContext is the same as ListSafetyRules with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListSafetyRules for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListSafetyRulesWithContext(ctx aws.Context, input *ListSafetyRulesInput, opts ...request.Option) (*ListSafetyRulesOutput, error) {
+ req, out := c.ListSafetyRulesRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListSafetyRulesPages iterates over the pages of a ListSafetyRules operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListSafetyRules method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListSafetyRules operation.
+// pageNum := 0
+// err := client.ListSafetyRulesPages(params,
+// func(page *route53recoverycontrolconfig.ListSafetyRulesOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryControlConfig) ListSafetyRulesPages(input *ListSafetyRulesInput, fn func(*ListSafetyRulesOutput, bool) bool) error {
+ return c.ListSafetyRulesPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListSafetyRulesPagesWithContext same as ListSafetyRulesPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) ListSafetyRulesPagesWithContext(ctx aws.Context, input *ListSafetyRulesInput, fn func(*ListSafetyRulesOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListSafetyRulesInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListSafetyRulesRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListSafetyRulesOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opUpdateControlPanel = "UpdateControlPanel"
+
+// UpdateControlPanelRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateControlPanel operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateControlPanel for more information on using the UpdateControlPanel
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateControlPanelRequest method.
+// req, resp := client.UpdateControlPanelRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateControlPanel
+func (c *Route53RecoveryControlConfig) UpdateControlPanelRequest(input *UpdateControlPanelInput) (req *request.Request, output *UpdateControlPanelOutput) {
+ op := &request.Operation{
+ Name: opUpdateControlPanel,
+ HTTPMethod: "PUT",
+ HTTPPath: "/controlpanel",
+ }
+
+ if input == nil {
+ input = &UpdateControlPanelInput{}
+ }
+
+ output = &UpdateControlPanelOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateControlPanel API operation for AWS Route53 Recovery Control Config.
+//
+// Updates a control panel. The only update you can make to a control panel
+// is to change the name of the control panel.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation UpdateControlPanel for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateControlPanel
+func (c *Route53RecoveryControlConfig) UpdateControlPanel(input *UpdateControlPanelInput) (*UpdateControlPanelOutput, error) {
+ req, out := c.UpdateControlPanelRequest(input)
+ return out, req.Send()
+}
+
+// UpdateControlPanelWithContext is the same as UpdateControlPanel with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateControlPanel for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) UpdateControlPanelWithContext(ctx aws.Context, input *UpdateControlPanelInput, opts ...request.Option) (*UpdateControlPanelOutput, error) {
+ req, out := c.UpdateControlPanelRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateRoutingControl = "UpdateRoutingControl"
+
+// UpdateRoutingControlRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateRoutingControl operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateRoutingControl for more information on using the UpdateRoutingControl
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateRoutingControlRequest method.
+// req, resp := client.UpdateRoutingControlRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateRoutingControl
+func (c *Route53RecoveryControlConfig) UpdateRoutingControlRequest(input *UpdateRoutingControlInput) (req *request.Request, output *UpdateRoutingControlOutput) {
+ op := &request.Operation{
+ Name: opUpdateRoutingControl,
+ HTTPMethod: "PUT",
+ HTTPPath: "/routingcontrol",
+ }
+
+ if input == nil {
+ input = &UpdateRoutingControlInput{}
+ }
+
+ output = &UpdateRoutingControlOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateRoutingControl API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation UpdateRoutingControl for usage and error information.
+//
+// Returned Error Types:
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// * AccessDeniedException
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+//
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ThrottlingException
+// 429 response - ThrottlingException.
+//
+// * ConflictException
+// 409 response - ConflictException.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateRoutingControl
+func (c *Route53RecoveryControlConfig) UpdateRoutingControl(input *UpdateRoutingControlInput) (*UpdateRoutingControlOutput, error) {
+ req, out := c.UpdateRoutingControlRequest(input)
+ return out, req.Send()
+}
+
+// UpdateRoutingControlWithContext is the same as UpdateRoutingControl with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateRoutingControl for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) UpdateRoutingControlWithContext(ctx aws.Context, input *UpdateRoutingControlInput, opts ...request.Option) (*UpdateRoutingControlOutput, error) {
+ req, out := c.UpdateRoutingControlRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateSafetyRule = "UpdateSafetyRule"
+
+// UpdateSafetyRuleRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateSafetyRule operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateSafetyRule for more information on using the UpdateSafetyRule
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateSafetyRuleRequest method.
+// req, resp := client.UpdateSafetyRuleRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateSafetyRule
+func (c *Route53RecoveryControlConfig) UpdateSafetyRuleRequest(input *UpdateSafetyRuleInput) (req *request.Request, output *UpdateSafetyRuleOutput) {
+ op := &request.Operation{
+ Name: opUpdateSafetyRule,
+ HTTPMethod: "PUT",
+ HTTPPath: "/safetyrule",
+ }
+
+ if input == nil {
+ input = &UpdateSafetyRuleInput{}
+ }
+
+ output = &UpdateSafetyRuleOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateSafetyRule API operation for AWS Route53 Recovery Control Config.
+//
+// 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.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Control Config's
+// API operation UpdateSafetyRule for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+// 404 response - The query string contains a syntax error or resource not found.
+//
+// * ValidationException
+// 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.
+//
+// * InternalServerException
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/UpdateSafetyRule
+func (c *Route53RecoveryControlConfig) UpdateSafetyRule(input *UpdateSafetyRuleInput) (*UpdateSafetyRuleOutput, error) {
+ req, out := c.UpdateSafetyRuleRequest(input)
+ return out, req.Send()
+}
+
+// UpdateSafetyRuleWithContext is the same as UpdateSafetyRule with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateSafetyRule for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) UpdateSafetyRuleWithContext(ctx aws.Context, input *UpdateSafetyRuleInput, opts ...request.Option) (*UpdateSafetyRuleOutput, error) {
+ req, out := c.UpdateSafetyRuleRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// 403 response - AccessDeniedException. You do not have sufficient access to
+// perform this action.
+type AccessDeniedException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s AccessDeniedException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AccessDeniedException) GoString() string {
+ return s.String()
+}
+
+func newErrorAccessDeniedException(v protocol.ResponseMetadata) error {
+ return &AccessDeniedException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *AccessDeniedException) Code() string {
+ return "AccessDeniedException"
+}
+
+// Message returns the exception's message.
+func (s *AccessDeniedException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *AccessDeniedException) OrigErr() error {
+ return nil
+}
+
+func (s *AccessDeniedException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *AccessDeniedException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *AccessDeniedException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// 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.
+type AssertionRule struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ //
+ // AssertedControls is a required field
+ AssertedControls []*string `type:"list" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the control panel.
+ //
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `type:"string" required:"true"`
+
+ // Name of the assertion rule. You can use any non-white space character in
+ // the name.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // 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.
+ //
+ // RuleConfig is a required field
+ RuleConfig *RuleConfig `type:"structure" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the assertion rule.
+ //
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `type:"string" required:"true"`
+
+ // The deployment status of an assertion rule. Status can be one of the following:
+ // PENDING, DEPLOYED, PENDING_DELETION.
+ //
+ // Status is a required field
+ Status *string `type:"string" required:"true" enum:"Status"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s AssertionRule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AssertionRule) GoString() string {
+ return s.String()
+}
+
+// SetAssertedControls sets the AssertedControls field's value.
+func (s *AssertionRule) SetAssertedControls(v []*string) *AssertionRule {
+ s.AssertedControls = v
+ return s
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *AssertionRule) SetControlPanelArn(v string) *AssertionRule {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *AssertionRule) SetName(v string) *AssertionRule {
+ s.Name = &v
+ return s
+}
+
+// SetRuleConfig sets the RuleConfig field's value.
+func (s *AssertionRule) SetRuleConfig(v *RuleConfig) *AssertionRule {
+ s.RuleConfig = v
+ return s
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *AssertionRule) SetSafetyRuleArn(v string) *AssertionRule {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AssertionRule) SetStatus(v string) *AssertionRule {
+ s.Status = &v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *AssertionRule) SetWaitPeriodMs(v int64) *AssertionRule {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// 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.
+type AssertionRuleUpdate struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the assertion rule. You can use any non-white space character
+ // in the name.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the assertion rule.
+ //
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `type:"string" required:"true"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s AssertionRuleUpdate) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AssertionRuleUpdate) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AssertionRuleUpdate) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AssertionRuleUpdate"}
+ if s.Name == nil {
+ invalidParams.Add(request.NewErrParamRequired("Name"))
+ }
+ if s.Name != nil && len(*s.Name) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Name", 1))
+ }
+ if s.SafetyRuleArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("SafetyRuleArn"))
+ }
+ if s.WaitPeriodMs == nil {
+ invalidParams.Add(request.NewErrParamRequired("WaitPeriodMs"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetName sets the Name field's value.
+func (s *AssertionRuleUpdate) SetName(v string) *AssertionRuleUpdate {
+ s.Name = &v
+ return s
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *AssertionRuleUpdate) SetSafetyRuleArn(v string) *AssertionRuleUpdate {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *AssertionRuleUpdate) SetWaitPeriodMs(v int64) *AssertionRuleUpdate {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// 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.
+type Cluster struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the cluster.
+ ClusterArn *string `type:"string"`
+
+ // 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.
+ ClusterEndpoints []*ClusterEndpoint `type:"list"`
+
+ // The name of the cluster.
+ Name *string `min:"1" type:"string"`
+
+ // Deployment status of a resource. Status can be one of the following: PENDING,
+ // DEPLOYED, PENDING_DELETION.
+ Status *string `type:"string" enum:"Status"`
+}
+
+// String returns the string representation
+func (s Cluster) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s Cluster) GoString() string {
+ return s.String()
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *Cluster) SetClusterArn(v string) *Cluster {
+ s.ClusterArn = &v
+ return s
+}
+
+// SetClusterEndpoints sets the ClusterEndpoints field's value.
+func (s *Cluster) SetClusterEndpoints(v []*ClusterEndpoint) *Cluster {
+ s.ClusterEndpoints = v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *Cluster) SetName(v string) *Cluster {
+ s.Name = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *Cluster) SetStatus(v string) *Cluster {
+ s.Status = &v
+ return s
+}
+
+// A cluster endpoint. Specify an endpoint when you want to set or retrieve
+// a routing control state in the cluster.
+type ClusterEndpoint struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ Endpoint *string `min:"1" type:"string"`
+
+ // The Amazon Web Services Region for a cluster endpoint.
+ Region *string `min:"1" type:"string"`
+}
+
+// String returns the string representation
+func (s ClusterEndpoint) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ClusterEndpoint) GoString() string {
+ return s.String()
+}
+
+// SetEndpoint sets the Endpoint field's value.
+func (s *ClusterEndpoint) SetEndpoint(v string) *ClusterEndpoint {
+ s.Endpoint = &v
+ return s
+}
+
+// SetRegion sets the Region field's value.
+func (s *ClusterEndpoint) SetRegion(v string) *ClusterEndpoint {
+ s.Region = &v
+ return s
+}
+
+// 409 response - ConflictException.
+type ConflictException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ConflictException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ConflictException) GoString() string {
+ return s.String()
+}
+
+func newErrorConflictException(v protocol.ResponseMetadata) error {
+ return &ConflictException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ConflictException) Code() string {
+ return "ConflictException"
+}
+
+// Message returns the exception's message.
+func (s *ConflictException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ConflictException) OrigErr() error {
+ return nil
+}
+
+func (s *ConflictException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ConflictException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ConflictException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// A control panel represents a group of routing controls that can be changed
+// together in a single transaction.
+type ControlPanel struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the cluster that includes the control panel.
+ ClusterArn *string `type:"string"`
+
+ // The Amazon Resource Name (ARN) of the control panel.
+ ControlPanelArn *string `type:"string"`
+
+ // 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.
+ DefaultControlPanel *bool `type:"boolean"`
+
+ // The name of the control panel. You can use any non-white space character
+ // in the name.
+ Name *string `min:"1" type:"string"`
+
+ // The number of routing controls in the control panel.
+ RoutingControlCount *int64 `type:"integer"`
+
+ // The deployment status of control panel. Status can be one of the following:
+ // PENDING, DEPLOYED, PENDING_DELETION.
+ Status *string `type:"string" enum:"Status"`
+}
+
+// String returns the string representation
+func (s ControlPanel) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ControlPanel) GoString() string {
+ return s.String()
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *ControlPanel) SetClusterArn(v string) *ControlPanel {
+ s.ClusterArn = &v
+ return s
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *ControlPanel) SetControlPanelArn(v string) *ControlPanel {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetDefaultControlPanel sets the DefaultControlPanel field's value.
+func (s *ControlPanel) SetDefaultControlPanel(v bool) *ControlPanel {
+ s.DefaultControlPanel = &v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *ControlPanel) SetName(v string) *ControlPanel {
+ s.Name = &v
+ return s
+}
+
+// SetRoutingControlCount sets the RoutingControlCount field's value.
+func (s *ControlPanel) SetRoutingControlCount(v int64) *ControlPanel {
+ s.RoutingControlCount = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *ControlPanel) SetStatus(v string) *ControlPanel {
+ s.Status = &v
+ return s
+}
+
+// The properties of a request to create a cluster.
+type CreateClusterInput struct {
+ _ struct{} `type:"structure"`
+
+ // Unique client idempotency token.
+ ClientToken *string `type:"string" idempotencyToken:"true"`
+
+ // The name of the cluster.
+ //
+ // ClusterName is a required field
+ ClusterName *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s CreateClusterInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateClusterInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateClusterInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateClusterInput"}
+ if s.ClusterName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterName"))
+ }
+ if s.ClusterName != nil && len(*s.ClusterName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ClusterName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClientToken sets the ClientToken field's value.
+func (s *CreateClusterInput) SetClientToken(v string) *CreateClusterInput {
+ s.ClientToken = &v
+ return s
+}
+
+// SetClusterName sets the ClusterName field's value.
+func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput {
+ s.ClusterName = &v
+ return s
+}
+
+// The result of a successful CreateCluster request.
+type CreateClusterOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The cluster that was created.
+ Cluster *Cluster `type:"structure"`
+}
+
+// String returns the string representation
+func (s CreateClusterOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateClusterOutput) GoString() string {
+ return s.String()
+}
+
+// SetCluster sets the Cluster field's value.
+func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput {
+ s.Cluster = v
+ return s
+}
+
+// A request to create a control panel.
+type CreateControlPanelInput struct {
+ _ struct{} `type:"structure"`
+
+ // Unique client idempotency token.
+ ClientToken *string `type:"string" idempotencyToken:"true"`
+
+ // The Amazon Resource Name (ARN) of the cluster for the control panel.
+ //
+ // ClusterArn is a required field
+ ClusterArn *string `type:"string" required:"true"`
+
+ // The name of the control panel.
+ //
+ // ControlPanelName is a required field
+ ControlPanelName *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s CreateControlPanelInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateControlPanelInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateControlPanelInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateControlPanelInput"}
+ if s.ClusterArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterArn"))
+ }
+ if s.ControlPanelName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelName"))
+ }
+ if s.ControlPanelName != nil && len(*s.ControlPanelName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClientToken sets the ClientToken field's value.
+func (s *CreateControlPanelInput) SetClientToken(v string) *CreateControlPanelInput {
+ s.ClientToken = &v
+ return s
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *CreateControlPanelInput) SetClusterArn(v string) *CreateControlPanelInput {
+ s.ClusterArn = &v
+ return s
+}
+
+// SetControlPanelName sets the ControlPanelName field's value.
+func (s *CreateControlPanelInput) SetControlPanelName(v string) *CreateControlPanelInput {
+ s.ControlPanelName = &v
+ return s
+}
+
+// The result of a successful CreateControlPanel request.
+type CreateControlPanelOutput struct {
+ _ struct{} `type:"structure"`
+
+ // Information about a control panel.
+ ControlPanel *ControlPanel `type:"structure"`
+}
+
+// String returns the string representation
+func (s CreateControlPanelOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateControlPanelOutput) GoString() string {
+ return s.String()
+}
+
+// SetControlPanel sets the ControlPanel field's value.
+func (s *CreateControlPanelOutput) SetControlPanel(v *ControlPanel) *CreateControlPanelOutput {
+ s.ControlPanel = v
+ return s
+}
+
+// A request to create a routing control. If you don't specify ControlPanelArn,
+// Amazon Route 53 Application Recovery Controller creates the routing control
+// in DefaultControlPanel.
+type CreateRoutingControlInput struct {
+ _ struct{} `type:"structure"`
+
+ // Unique client idempotency token.
+ ClientToken *string `type:"string" idempotencyToken:"true"`
+
+ // The Amazon Resource Name (ARN) of the cluster that includes the routing control.
+ //
+ // ClusterArn is a required field
+ ClusterArn *string `type:"string" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the control panel that includes the routing
+ // control.
+ ControlPanelArn *string `type:"string"`
+
+ // The name of the routing control.
+ //
+ // RoutingControlName is a required field
+ RoutingControlName *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s CreateRoutingControlInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateRoutingControlInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateRoutingControlInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateRoutingControlInput"}
+ if s.ClusterArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterArn"))
+ }
+ if s.RoutingControlName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlName"))
+ }
+ if s.RoutingControlName != nil && len(*s.RoutingControlName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClientToken sets the ClientToken field's value.
+func (s *CreateRoutingControlInput) SetClientToken(v string) *CreateRoutingControlInput {
+ s.ClientToken = &v
+ return s
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *CreateRoutingControlInput) SetClusterArn(v string) *CreateRoutingControlInput {
+ s.ClusterArn = &v
+ return s
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *CreateRoutingControlInput) SetControlPanelArn(v string) *CreateRoutingControlInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetRoutingControlName sets the RoutingControlName field's value.
+func (s *CreateRoutingControlInput) SetRoutingControlName(v string) *CreateRoutingControlInput {
+ s.RoutingControlName = &v
+ return s
+}
+
+// The result of a successful CreateRoutingControl request.
+type CreateRoutingControlOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The routing control that is created.
+ RoutingControl *RoutingControl `type:"structure"`
+}
+
+// String returns the string representation
+func (s CreateRoutingControlOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateRoutingControlOutput) GoString() string {
+ return s.String()
+}
+
+// SetRoutingControl sets the RoutingControl field's value.
+func (s *CreateRoutingControlOutput) SetRoutingControl(v *RoutingControl) *CreateRoutingControlOutput {
+ s.RoutingControl = v
+ return s
+}
+
+// Request to create a safety rule. You can create either an assertion rule
+// or a gating rule with a CreateSafetyRuleRequest call.
+type CreateSafetyRuleInput struct {
+ _ struct{} `type:"structure"`
+
+ // A new assertion rule for a control panel.
+ AssertionRule *NewAssertionRule `type:"structure"`
+
+ // Unique client idempotency token.
+ ClientToken *string `type:"string" idempotencyToken:"true"`
+
+ // A new gating rule for a control panel.
+ GatingRule *NewGatingRule `type:"structure"`
+}
+
+// String returns the string representation
+func (s CreateSafetyRuleInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateSafetyRuleInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateSafetyRuleInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateSafetyRuleInput"}
+ if s.AssertionRule != nil {
+ if err := s.AssertionRule.Validate(); err != nil {
+ invalidParams.AddNested("AssertionRule", err.(request.ErrInvalidParams))
+ }
+ }
+ if s.GatingRule != nil {
+ if err := s.GatingRule.Validate(); err != nil {
+ invalidParams.AddNested("GatingRule", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetAssertionRule sets the AssertionRule field's value.
+func (s *CreateSafetyRuleInput) SetAssertionRule(v *NewAssertionRule) *CreateSafetyRuleInput {
+ s.AssertionRule = v
+ return s
+}
+
+// SetClientToken sets the ClientToken field's value.
+func (s *CreateSafetyRuleInput) SetClientToken(v string) *CreateSafetyRuleInput {
+ s.ClientToken = &v
+ return s
+}
+
+// SetGatingRule sets the GatingRule field's value.
+func (s *CreateSafetyRuleInput) SetGatingRule(v *NewGatingRule) *CreateSafetyRuleInput {
+ s.GatingRule = v
+ return s
+}
+
+// The result of a successful CreateSafetyRule request.
+type CreateSafetyRuleOutput struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ AssertionRule *AssertionRule `type:"structure"`
+
+ // 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.
+ GatingRule *GatingRule `type:"structure"`
+}
+
+// String returns the string representation
+func (s CreateSafetyRuleOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateSafetyRuleOutput) GoString() string {
+ return s.String()
+}
+
+// SetAssertionRule sets the AssertionRule field's value.
+func (s *CreateSafetyRuleOutput) SetAssertionRule(v *AssertionRule) *CreateSafetyRuleOutput {
+ s.AssertionRule = v
+ return s
+}
+
+// SetGatingRule sets the GatingRule field's value.
+func (s *CreateSafetyRuleOutput) SetGatingRule(v *GatingRule) *CreateSafetyRuleOutput {
+ s.GatingRule = v
+ return s
+}
+
+type DeleteClusterInput struct {
+ _ struct{} `type:"structure"`
+
+ // ClusterArn is a required field
+ ClusterArn *string `location:"uri" locationName:"ClusterArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteClusterInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteClusterInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteClusterInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteClusterInput"}
+ if s.ClusterArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterArn"))
+ }
+ if s.ClusterArn != nil && len(*s.ClusterArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ClusterArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *DeleteClusterInput) SetClusterArn(v string) *DeleteClusterInput {
+ s.ClusterArn = &v
+ return s
+}
+
+// A successful DeleteCluster request returns no response.
+type DeleteClusterOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteClusterOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteClusterOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteControlPanelInput struct {
+ _ struct{} `type:"structure"`
+
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `location:"uri" locationName:"ControlPanelArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteControlPanelInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteControlPanelInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteControlPanelInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteControlPanelInput"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.ControlPanelArn != nil && len(*s.ControlPanelArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *DeleteControlPanelInput) SetControlPanelArn(v string) *DeleteControlPanelInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// A successful DeleteControlPanel request returns no response.
+type DeleteControlPanelOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteControlPanelOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteControlPanelOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteRoutingControlInput struct {
+ _ struct{} `type:"structure"`
+
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `location:"uri" locationName:"RoutingControlArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteRoutingControlInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteRoutingControlInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteRoutingControlInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteRoutingControlInput"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *DeleteRoutingControlInput) SetRoutingControlArn(v string) *DeleteRoutingControlInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// A successful DeleteRoutingControl request returns no response.
+type DeleteRoutingControlOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteRoutingControlOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteRoutingControlOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteSafetyRuleInput struct {
+ _ struct{} `type:"structure"`
+
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `location:"uri" locationName:"SafetyRuleArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteSafetyRuleInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteSafetyRuleInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteSafetyRuleInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteSafetyRuleInput"}
+ if s.SafetyRuleArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("SafetyRuleArn"))
+ }
+ if s.SafetyRuleArn != nil && len(*s.SafetyRuleArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("SafetyRuleArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *DeleteSafetyRuleInput) SetSafetyRuleArn(v string) *DeleteSafetyRuleInput {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// There is an empty response when you delete a safety rule.
+// />
+type DeleteSafetyRuleOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteSafetyRuleOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteSafetyRuleOutput) GoString() string {
+ return s.String()
+}
+
+type DescribeClusterInput struct {
+ _ struct{} `type:"structure"`
+
+ // ClusterArn is a required field
+ ClusterArn *string `location:"uri" locationName:"ClusterArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DescribeClusterInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeClusterInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DescribeClusterInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DescribeClusterInput"}
+ if s.ClusterArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ClusterArn"))
+ }
+ if s.ClusterArn != nil && len(*s.ClusterArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ClusterArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *DescribeClusterInput) SetClusterArn(v string) *DescribeClusterInput {
+ s.ClusterArn = &v
+ return s
+}
+
+// The result of a successful DescribeCluster request.
+type DescribeClusterOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The cluster for the DescribeCluster request.
+ Cluster *Cluster `type:"structure"`
+}
+
+// String returns the string representation
+func (s DescribeClusterOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeClusterOutput) GoString() string {
+ return s.String()
+}
+
+// SetCluster sets the Cluster field's value.
+func (s *DescribeClusterOutput) SetCluster(v *Cluster) *DescribeClusterOutput {
+ s.Cluster = v
+ return s
+}
+
+type DescribeControlPanelInput struct {
+ _ struct{} `type:"structure"`
+
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `location:"uri" locationName:"ControlPanelArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DescribeControlPanelInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeControlPanelInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DescribeControlPanelInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DescribeControlPanelInput"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.ControlPanelArn != nil && len(*s.ControlPanelArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *DescribeControlPanelInput) SetControlPanelArn(v string) *DescribeControlPanelInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// The result of a successful DescribeControlPanel request.
+type DescribeControlPanelOutput struct {
+ _ struct{} `type:"structure"`
+
+ // Information about the control panel.
+ ControlPanel *ControlPanel `type:"structure"`
+}
+
+// String returns the string representation
+func (s DescribeControlPanelOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeControlPanelOutput) GoString() string {
+ return s.String()
+}
+
+// SetControlPanel sets the ControlPanel field's value.
+func (s *DescribeControlPanelOutput) SetControlPanel(v *ControlPanel) *DescribeControlPanelOutput {
+ s.ControlPanel = v
+ return s
+}
+
+type DescribeRoutingControlInput struct {
+ _ struct{} `type:"structure"`
+
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `location:"uri" locationName:"RoutingControlArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DescribeRoutingControlInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeRoutingControlInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DescribeRoutingControlInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DescribeRoutingControlInput"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *DescribeRoutingControlInput) SetRoutingControlArn(v string) *DescribeRoutingControlInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// The result of a successful DescribeRoutingControl request.
+type DescribeRoutingControlOutput struct {
+ _ struct{} `type:"structure"`
+
+ // Information about the routing control.
+ RoutingControl *RoutingControl `type:"structure"`
+}
+
+// String returns the string representation
+func (s DescribeRoutingControlOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeRoutingControlOutput) GoString() string {
+ return s.String()
+}
+
+// SetRoutingControl sets the RoutingControl field's value.
+func (s *DescribeRoutingControlOutput) SetRoutingControl(v *RoutingControl) *DescribeRoutingControlOutput {
+ s.RoutingControl = v
+ return s
+}
+
+type DescribeSafetyRuleInput struct {
+ _ struct{} `type:"structure"`
+
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `location:"uri" locationName:"SafetyRuleArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DescribeSafetyRuleInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeSafetyRuleInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DescribeSafetyRuleInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DescribeSafetyRuleInput"}
+ if s.SafetyRuleArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("SafetyRuleArn"))
+ }
+ if s.SafetyRuleArn != nil && len(*s.SafetyRuleArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("SafetyRuleArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *DescribeSafetyRuleInput) SetSafetyRuleArn(v string) *DescribeSafetyRuleInput {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// The response when you send a DescribeSafetyRuleResponse request.
+type DescribeSafetyRuleOutput struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ AssertionRule *AssertionRule `type:"structure"`
+
+ // 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.
+ GatingRule *GatingRule `type:"structure"`
+}
+
+// String returns the string representation
+func (s DescribeSafetyRuleOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DescribeSafetyRuleOutput) GoString() string {
+ return s.String()
+}
+
+// SetAssertionRule sets the AssertionRule field's value.
+func (s *DescribeSafetyRuleOutput) SetAssertionRule(v *AssertionRule) *DescribeSafetyRuleOutput {
+ s.AssertionRule = v
+ return s
+}
+
+// SetGatingRule sets the GatingRule field's value.
+func (s *DescribeSafetyRuleOutput) SetGatingRule(v *GatingRule) *DescribeSafetyRuleOutput {
+ s.GatingRule = v
+ return s
+}
+
+// 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.
+type GatingRule struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the control panel.
+ //
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `type:"string" required:"true"`
+
+ // The gating controls for the gating rule. That is, routing controls that are
+ // evaluated by the rule configuration that you specify.
+ //
+ // GatingControls is a required field
+ GatingControls []*string `type:"list" required:"true"`
+
+ // The name for the gating rule.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // 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.
+ //
+ // RuleConfig is a required field
+ RuleConfig *RuleConfig `type:"structure" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the gating rule.
+ //
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `type:"string" required:"true"`
+
+ // The deployment status of a gating rule. Status can be one of the following:
+ // PENDING, DEPLOYED, PENDING_DELETION.
+ //
+ // Status is a required field
+ Status *string `type:"string" required:"true" enum:"Status"`
+
+ // 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.
+ //
+ // TargetControls is a required field
+ TargetControls []*string `type:"list" required:"true"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s GatingRule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GatingRule) GoString() string {
+ return s.String()
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *GatingRule) SetControlPanelArn(v string) *GatingRule {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetGatingControls sets the GatingControls field's value.
+func (s *GatingRule) SetGatingControls(v []*string) *GatingRule {
+ s.GatingControls = v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *GatingRule) SetName(v string) *GatingRule {
+ s.Name = &v
+ return s
+}
+
+// SetRuleConfig sets the RuleConfig field's value.
+func (s *GatingRule) SetRuleConfig(v *RuleConfig) *GatingRule {
+ s.RuleConfig = v
+ return s
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *GatingRule) SetSafetyRuleArn(v string) *GatingRule {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *GatingRule) SetStatus(v string) *GatingRule {
+ s.Status = &v
+ return s
+}
+
+// SetTargetControls sets the TargetControls field's value.
+func (s *GatingRule) SetTargetControls(v []*string) *GatingRule {
+ s.TargetControls = v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *GatingRule) SetWaitPeriodMs(v int64) *GatingRule {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// 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.
+type GatingRuleUpdate struct {
+ _ struct{} `type:"structure"`
+
+ // The name for the gating rule.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // The Amazon Resource Name (ARN) of the gating rule.
+ //
+ // SafetyRuleArn is a required field
+ SafetyRuleArn *string `type:"string" required:"true"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s GatingRuleUpdate) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GatingRuleUpdate) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GatingRuleUpdate) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GatingRuleUpdate"}
+ if s.Name == nil {
+ invalidParams.Add(request.NewErrParamRequired("Name"))
+ }
+ if s.Name != nil && len(*s.Name) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Name", 1))
+ }
+ if s.SafetyRuleArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("SafetyRuleArn"))
+ }
+ if s.WaitPeriodMs == nil {
+ invalidParams.Add(request.NewErrParamRequired("WaitPeriodMs"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetName sets the Name field's value.
+func (s *GatingRuleUpdate) SetName(v string) *GatingRuleUpdate {
+ s.Name = &v
+ return s
+}
+
+// SetSafetyRuleArn sets the SafetyRuleArn field's value.
+func (s *GatingRuleUpdate) SetSafetyRuleArn(v string) *GatingRuleUpdate {
+ s.SafetyRuleArn = &v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *GatingRuleUpdate) SetWaitPeriodMs(v int64) *GatingRuleUpdate {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// 500 response - InternalServiceError. Temporary service error. Retry the request.
+type InternalServerException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s InternalServerException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s InternalServerException) GoString() string {
+ return s.String()
+}
+
+func newErrorInternalServerException(v protocol.ResponseMetadata) error {
+ return &InternalServerException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *InternalServerException) Code() string {
+ return "InternalServerException"
+}
+
+// Message returns the exception's message.
+func (s *InternalServerException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *InternalServerException) OrigErr() error {
+ return nil
+}
+
+func (s *InternalServerException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *InternalServerException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *InternalServerException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type ListAssociatedRoute53HealthChecksInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
+
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `location:"uri" locationName:"RoutingControlArn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ListAssociatedRoute53HealthChecksInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListAssociatedRoute53HealthChecksInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListAssociatedRoute53HealthChecksInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListAssociatedRoute53HealthChecksInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlArn != nil && len(*s.RoutingControlArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListAssociatedRoute53HealthChecksInput) SetMaxResults(v int64) *ListAssociatedRoute53HealthChecksInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListAssociatedRoute53HealthChecksInput) SetNextToken(v string) *ListAssociatedRoute53HealthChecksInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *ListAssociatedRoute53HealthChecksInput) SetRoutingControlArn(v string) *ListAssociatedRoute53HealthChecksInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// The result of a successful ListAssociatedRoute53HealthChecks request.
+type ListAssociatedRoute53HealthChecksOutput struct {
+ _ struct{} `type:"structure"`
+
+ // Identifiers for the health checks.
+ HealthCheckIds []*string `type:"list"`
+
+ // The token that identifies which batch of results you want to see.
+ NextToken *string `type:"string"`
+}
+
+// String returns the string representation
+func (s ListAssociatedRoute53HealthChecksOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListAssociatedRoute53HealthChecksOutput) GoString() string {
+ return s.String()
+}
+
+// SetHealthCheckIds sets the HealthCheckIds field's value.
+func (s *ListAssociatedRoute53HealthChecksOutput) SetHealthCheckIds(v []*string) *ListAssociatedRoute53HealthChecksOutput {
+ s.HealthCheckIds = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListAssociatedRoute53HealthChecksOutput) SetNextToken(v string) *ListAssociatedRoute53HealthChecksOutput {
+ s.NextToken = &v
+ return s
+}
+
+type ListClustersInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListClustersInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListClustersInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListClustersInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListClustersInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput {
+ s.NextToken = &v
+ return s
+}
+
+// The result of a successful ListClusters request.
+type ListClustersOutput struct {
+ _ struct{} `type:"structure"`
+
+ // An array of the clusters in an account.
+ Clusters []*Cluster `type:"list"`
+
+ // The token that identifies which batch of results you want to see.
+ NextToken *string `type:"string"`
+}
+
+// String returns the string representation
+func (s ListClustersOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListClustersOutput) GoString() string {
+ return s.String()
+}
+
+// SetClusters sets the Clusters field's value.
+func (s *ListClustersOutput) SetClusters(v []*Cluster) *ListClustersOutput {
+ s.Clusters = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput {
+ s.NextToken = &v
+ return s
+}
+
+type ListControlPanelsInput struct {
+ _ struct{} `type:"structure"`
+
+ ClusterArn *string `location:"querystring" locationName:"ClusterArn" type:"string"`
+
+ MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListControlPanelsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListControlPanelsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListControlPanelsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListControlPanelsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetClusterArn sets the ClusterArn field's value.
+func (s *ListControlPanelsInput) SetClusterArn(v string) *ListControlPanelsInput {
+ s.ClusterArn = &v
+ return s
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListControlPanelsInput) SetMaxResults(v int64) *ListControlPanelsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListControlPanelsInput) SetNextToken(v string) *ListControlPanelsInput {
+ s.NextToken = &v
+ return s
+}
+
+// The result of a successful ListControlPanel request.
+type ListControlPanelsOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The result of a successful ListControlPanel request.
+ ControlPanels []*ControlPanel `type:"list"`
+
+ // The token that identifies which batch of results you want to see.
+ NextToken *string `type:"string"`
+}
+
+// String returns the string representation
+func (s ListControlPanelsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListControlPanelsOutput) GoString() string {
+ return s.String()
+}
+
+// SetControlPanels sets the ControlPanels field's value.
+func (s *ListControlPanelsOutput) SetControlPanels(v []*ControlPanel) *ListControlPanelsOutput {
+ s.ControlPanels = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListControlPanelsOutput) SetNextToken(v string) *ListControlPanelsOutput {
+ s.NextToken = &v
+ return s
+}
+
+type ListRoutingControlsInput struct {
+ _ struct{} `type:"structure"`
+
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `location:"uri" locationName:"ControlPanelArn" type:"string" required:"true"`
+
+ MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListRoutingControlsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRoutingControlsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListRoutingControlsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListRoutingControlsInput"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.ControlPanelArn != nil && len(*s.ControlPanelArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelArn", 1))
+ }
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *ListRoutingControlsInput) SetControlPanelArn(v string) *ListRoutingControlsInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListRoutingControlsInput) SetMaxResults(v int64) *ListRoutingControlsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRoutingControlsInput) SetNextToken(v string) *ListRoutingControlsInput {
+ s.NextToken = &v
+ return s
+}
+
+// The result of a successful ListRoutingControl request.
+type ListRoutingControlsOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The token that identifies which batch of results you want to see.
+ NextToken *string `type:"string"`
+
+ // An array of routing controls.
+ RoutingControls []*RoutingControl `type:"list"`
+}
+
+// String returns the string representation
+func (s ListRoutingControlsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRoutingControlsOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRoutingControlsOutput) SetNextToken(v string) *ListRoutingControlsOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRoutingControls sets the RoutingControls field's value.
+func (s *ListRoutingControlsOutput) SetRoutingControls(v []*RoutingControl) *ListRoutingControlsOutput {
+ s.RoutingControls = v
+ return s
+}
+
+type ListSafetyRulesInput struct {
+ _ struct{} `type:"structure"`
+
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `location:"uri" locationName:"ControlPanelArn" type:"string" required:"true"`
+
+ MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListSafetyRulesInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListSafetyRulesInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListSafetyRulesInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListSafetyRulesInput"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.ControlPanelArn != nil && len(*s.ControlPanelArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelArn", 1))
+ }
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *ListSafetyRulesInput) SetControlPanelArn(v string) *ListSafetyRulesInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListSafetyRulesInput) SetMaxResults(v int64) *ListSafetyRulesInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListSafetyRulesInput) SetNextToken(v string) *ListSafetyRulesInput {
+ s.NextToken = &v
+ return s
+}
+
+// The response to a ListSafetyRulesRequest.
+type ListSafetyRulesOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The token that identifies which batch of results you want to see.
+ NextToken *string `type:"string"`
+
+ // The list of safety rules in a control panel.
+ SafetyRules []*Rule `type:"list"`
+}
+
+// String returns the string representation
+func (s ListSafetyRulesOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListSafetyRulesOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListSafetyRulesOutput) SetNextToken(v string) *ListSafetyRulesOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetSafetyRules sets the SafetyRules field's value.
+func (s *ListSafetyRulesOutput) SetSafetyRules(v []*Rule) *ListSafetyRulesOutput {
+ s.SafetyRules = v
+ return s
+}
+
+// A new assertion rule for a control panel.
+type NewAssertionRule struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ //
+ // AssertedControls is a required field
+ AssertedControls []*string `type:"list" required:"true"`
+
+ // The Amazon Resource Name (ARN) for the control panel.
+ //
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `type:"string" required:"true"`
+
+ // The name of the assertion rule. You can use any non-white space character
+ // in the name.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // 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.
+ //
+ // RuleConfig is a required field
+ RuleConfig *RuleConfig `type:"structure" required:"true"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s NewAssertionRule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s NewAssertionRule) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *NewAssertionRule) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "NewAssertionRule"}
+ if s.AssertedControls == nil {
+ invalidParams.Add(request.NewErrParamRequired("AssertedControls"))
+ }
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.Name == nil {
+ invalidParams.Add(request.NewErrParamRequired("Name"))
+ }
+ if s.Name != nil && len(*s.Name) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Name", 1))
+ }
+ if s.RuleConfig == nil {
+ invalidParams.Add(request.NewErrParamRequired("RuleConfig"))
+ }
+ if s.WaitPeriodMs == nil {
+ invalidParams.Add(request.NewErrParamRequired("WaitPeriodMs"))
+ }
+ if s.RuleConfig != nil {
+ if err := s.RuleConfig.Validate(); err != nil {
+ invalidParams.AddNested("RuleConfig", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetAssertedControls sets the AssertedControls field's value.
+func (s *NewAssertionRule) SetAssertedControls(v []*string) *NewAssertionRule {
+ s.AssertedControls = v
+ return s
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *NewAssertionRule) SetControlPanelArn(v string) *NewAssertionRule {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *NewAssertionRule) SetName(v string) *NewAssertionRule {
+ s.Name = &v
+ return s
+}
+
+// SetRuleConfig sets the RuleConfig field's value.
+func (s *NewAssertionRule) SetRuleConfig(v *RuleConfig) *NewAssertionRule {
+ s.RuleConfig = v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *NewAssertionRule) SetWaitPeriodMs(v int64) *NewAssertionRule {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// A new gating rule for a control panel.
+type NewGatingRule struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the control panel.
+ //
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `type:"string" required:"true"`
+
+ // The gating controls for the new gating rule. That is, routing controls that
+ // are evaluated by the rule configuration that you specify.
+ //
+ // GatingControls is a required field
+ GatingControls []*string `type:"list" required:"true"`
+
+ // The name for the new gating rule.
+ //
+ // Name is a required field
+ Name *string `min:"1" type:"string" required:"true"`
+
+ // 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.
+ //
+ // RuleConfig is a required field
+ RuleConfig *RuleConfig `type:"structure" required:"true"`
+
+ // 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.
+ //
+ // TargetControls is a required field
+ TargetControls []*string `type:"list" required:"true"`
+
+ // 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.
+ //
+ // WaitPeriodMs is a required field
+ WaitPeriodMs *int64 `type:"integer" required:"true"`
+}
+
+// String returns the string representation
+func (s NewGatingRule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s NewGatingRule) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *NewGatingRule) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "NewGatingRule"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.GatingControls == nil {
+ invalidParams.Add(request.NewErrParamRequired("GatingControls"))
+ }
+ if s.Name == nil {
+ invalidParams.Add(request.NewErrParamRequired("Name"))
+ }
+ if s.Name != nil && len(*s.Name) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Name", 1))
+ }
+ if s.RuleConfig == nil {
+ invalidParams.Add(request.NewErrParamRequired("RuleConfig"))
+ }
+ if s.TargetControls == nil {
+ invalidParams.Add(request.NewErrParamRequired("TargetControls"))
+ }
+ if s.WaitPeriodMs == nil {
+ invalidParams.Add(request.NewErrParamRequired("WaitPeriodMs"))
+ }
+ if s.RuleConfig != nil {
+ if err := s.RuleConfig.Validate(); err != nil {
+ invalidParams.AddNested("RuleConfig", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *NewGatingRule) SetControlPanelArn(v string) *NewGatingRule {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetGatingControls sets the GatingControls field's value.
+func (s *NewGatingRule) SetGatingControls(v []*string) *NewGatingRule {
+ s.GatingControls = v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *NewGatingRule) SetName(v string) *NewGatingRule {
+ s.Name = &v
+ return s
+}
+
+// SetRuleConfig sets the RuleConfig field's value.
+func (s *NewGatingRule) SetRuleConfig(v *RuleConfig) *NewGatingRule {
+ s.RuleConfig = v
+ return s
+}
+
+// SetTargetControls sets the TargetControls field's value.
+func (s *NewGatingRule) SetTargetControls(v []*string) *NewGatingRule {
+ s.TargetControls = v
+ return s
+}
+
+// SetWaitPeriodMs sets the WaitPeriodMs field's value.
+func (s *NewGatingRule) SetWaitPeriodMs(v int64) *NewGatingRule {
+ s.WaitPeriodMs = &v
+ return s
+}
+
+// 404 response - The query string contains a syntax error or resource not found.
+type ResourceNotFoundException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ResourceNotFoundException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ResourceNotFoundException) GoString() string {
+ return s.String()
+}
+
+func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
+ return &ResourceNotFoundException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ResourceNotFoundException) Code() string {
+ return "ResourceNotFoundException"
+}
+
+// Message returns the exception's message.
+func (s *ResourceNotFoundException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ResourceNotFoundException) OrigErr() error {
+ return nil
+}
+
+func (s *ResourceNotFoundException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ResourceNotFoundException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ResourceNotFoundException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// 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.
+type RoutingControl struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the control panel that includes the routing
+ // control.
+ ControlPanelArn *string `type:"string"`
+
+ // The name of the routing control.
+ Name *string `min:"1" type:"string"`
+
+ // The Amazon Resource Name (ARN) of the routing control.
+ RoutingControlArn *string `type:"string"`
+
+ // The deployment status of a routing control. Status can be one of the following:
+ // PENDING, DEPLOYED, PENDING_DELETION.
+ Status *string `type:"string" enum:"Status"`
+}
+
+// String returns the string representation
+func (s RoutingControl) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RoutingControl) GoString() string {
+ return s.String()
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *RoutingControl) SetControlPanelArn(v string) *RoutingControl {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *RoutingControl) SetName(v string) *RoutingControl {
+ s.Name = &v
+ return s
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *RoutingControl) SetRoutingControlArn(v string) *RoutingControl {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *RoutingControl) SetStatus(v string) *RoutingControl {
+ s.Status = &v
+ return s
+}
+
+// A safety rule. A safety rule can be an assertion rule or a gating rule.
+type Rule struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ ASSERTION *AssertionRule `type:"structure"`
+
+ // 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.
+ GATING *GatingRule `type:"structure"`
+}
+
+// String returns the string representation
+func (s Rule) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s Rule) GoString() string {
+ return s.String()
+}
+
+// SetASSERTION sets the ASSERTION field's value.
+func (s *Rule) SetASSERTION(v *AssertionRule) *Rule {
+ s.ASSERTION = v
+ return s
+}
+
+// SetGATING sets the GATING field's value.
+func (s *Rule) SetGATING(v *GatingRule) *Rule {
+ s.GATING = v
+ return s
+}
+
+// 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.
+type RuleConfig struct {
+ _ struct{} `type:"structure"`
+
+ // Logical negation of the rule. If the rule would usually evaluate true, it's
+ // evaluated as false, and vice versa.
+ //
+ // Inverted is a required field
+ Inverted *bool `type:"boolean" required:"true"`
+
+ // 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.
+ //
+ // Threshold is a required field
+ Threshold *int64 `type:"integer" required:"true"`
+
+ // A rule can be one of the following: ATLEAST, AND, or OR.
+ //
+ // Type is a required field
+ Type *string `type:"string" required:"true" enum:"RuleType"`
+}
+
+// String returns the string representation
+func (s RuleConfig) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RuleConfig) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *RuleConfig) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "RuleConfig"}
+ if s.Inverted == nil {
+ invalidParams.Add(request.NewErrParamRequired("Inverted"))
+ }
+ if s.Threshold == nil {
+ invalidParams.Add(request.NewErrParamRequired("Threshold"))
+ }
+ if s.Type == nil {
+ invalidParams.Add(request.NewErrParamRequired("Type"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetInverted sets the Inverted field's value.
+func (s *RuleConfig) SetInverted(v bool) *RuleConfig {
+ s.Inverted = &v
+ return s
+}
+
+// SetThreshold sets the Threshold field's value.
+func (s *RuleConfig) SetThreshold(v int64) *RuleConfig {
+ s.Threshold = &v
+ return s
+}
+
+// SetType sets the Type field's value.
+func (s *RuleConfig) SetType(v string) *RuleConfig {
+ s.Type = &v
+ return s
+}
+
+// 402 response
+type ServiceQuotaExceededException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ServiceQuotaExceededException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ServiceQuotaExceededException) GoString() string {
+ return s.String()
+}
+
+func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error {
+ return &ServiceQuotaExceededException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ServiceQuotaExceededException) Code() string {
+ return "ServiceQuotaExceededException"
+}
+
+// Message returns the exception's message.
+func (s *ServiceQuotaExceededException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ServiceQuotaExceededException) OrigErr() error {
+ return nil
+}
+
+func (s *ServiceQuotaExceededException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ServiceQuotaExceededException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ServiceQuotaExceededException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// 429 response - ThrottlingException.
+type ThrottlingException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ThrottlingException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ThrottlingException) GoString() string {
+ return s.String()
+}
+
+func newErrorThrottlingException(v protocol.ResponseMetadata) error {
+ return &ThrottlingException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ThrottlingException) Code() string {
+ return "ThrottlingException"
+}
+
+// Message returns the exception's message.
+func (s *ThrottlingException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ThrottlingException) OrigErr() error {
+ return nil
+}
+
+func (s *ThrottlingException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ThrottlingException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ThrottlingException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// Updates an existing control panel.
+type UpdateControlPanelInput struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the control panel.
+ //
+ // ControlPanelArn is a required field
+ ControlPanelArn *string `type:"string" required:"true"`
+
+ // The name of the control panel.
+ //
+ // ControlPanelName is a required field
+ ControlPanelName *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateControlPanelInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateControlPanelInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateControlPanelInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateControlPanelInput"}
+ if s.ControlPanelArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelArn"))
+ }
+ if s.ControlPanelName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ControlPanelName"))
+ }
+ if s.ControlPanelName != nil && len(*s.ControlPanelName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ControlPanelName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetControlPanelArn sets the ControlPanelArn field's value.
+func (s *UpdateControlPanelInput) SetControlPanelArn(v string) *UpdateControlPanelInput {
+ s.ControlPanelArn = &v
+ return s
+}
+
+// SetControlPanelName sets the ControlPanelName field's value.
+func (s *UpdateControlPanelInput) SetControlPanelName(v string) *UpdateControlPanelInput {
+ s.ControlPanelName = &v
+ return s
+}
+
+// The result of a successful UpdateControlPanel request.
+type UpdateControlPanelOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The control panel to update.
+ ControlPanel *ControlPanel `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateControlPanelOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateControlPanelOutput) GoString() string {
+ return s.String()
+}
+
+// SetControlPanel sets the ControlPanel field's value.
+func (s *UpdateControlPanelOutput) SetControlPanel(v *ControlPanel) *UpdateControlPanelOutput {
+ s.ControlPanel = v
+ return s
+}
+
+// A request to update a routing control.
+type UpdateRoutingControlInput struct {
+ _ struct{} `type:"structure"`
+
+ // The Amazon Resource Name (ARN) of the routing control.
+ //
+ // RoutingControlArn is a required field
+ RoutingControlArn *string `type:"string" required:"true"`
+
+ // The name of the routing control.
+ //
+ // RoutingControlName is a required field
+ RoutingControlName *string `min:"1" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateRoutingControlInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateRoutingControlInput"}
+ if s.RoutingControlArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlArn"))
+ }
+ if s.RoutingControlName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RoutingControlName"))
+ }
+ if s.RoutingControlName != nil && len(*s.RoutingControlName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RoutingControlName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRoutingControlArn sets the RoutingControlArn field's value.
+func (s *UpdateRoutingControlInput) SetRoutingControlArn(v string) *UpdateRoutingControlInput {
+ s.RoutingControlArn = &v
+ return s
+}
+
+// SetRoutingControlName sets the RoutingControlName field's value.
+func (s *UpdateRoutingControlInput) SetRoutingControlName(v string) *UpdateRoutingControlInput {
+ s.RoutingControlName = &v
+ return s
+}
+
+// The result of a successful UpdateRoutingControl request.
+type UpdateRoutingControlOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The routing control that was updated.
+ RoutingControl *RoutingControl `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateRoutingControlOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRoutingControlOutput) GoString() string {
+ return s.String()
+}
+
+// SetRoutingControl sets the RoutingControl field's value.
+func (s *UpdateRoutingControlOutput) SetRoutingControl(v *RoutingControl) *UpdateRoutingControlOutput {
+ s.RoutingControl = v
+ return s
+}
+
+// Request to update a safety rule. A safety rule can be an assertion rule or
+// a gating rule.
+type UpdateSafetyRuleInput struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ AssertionRuleUpdate *AssertionRuleUpdate `type:"structure"`
+
+ // 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.
+ GatingRuleUpdate *GatingRuleUpdate `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateSafetyRuleInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateSafetyRuleInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateSafetyRuleInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateSafetyRuleInput"}
+ if s.AssertionRuleUpdate != nil {
+ if err := s.AssertionRuleUpdate.Validate(); err != nil {
+ invalidParams.AddNested("AssertionRuleUpdate", err.(request.ErrInvalidParams))
+ }
+ }
+ if s.GatingRuleUpdate != nil {
+ if err := s.GatingRuleUpdate.Validate(); err != nil {
+ invalidParams.AddNested("GatingRuleUpdate", err.(request.ErrInvalidParams))
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetAssertionRuleUpdate sets the AssertionRuleUpdate field's value.
+func (s *UpdateSafetyRuleInput) SetAssertionRuleUpdate(v *AssertionRuleUpdate) *UpdateSafetyRuleInput {
+ s.AssertionRuleUpdate = v
+ return s
+}
+
+// SetGatingRuleUpdate sets the GatingRuleUpdate field's value.
+func (s *UpdateSafetyRuleInput) SetGatingRuleUpdate(v *GatingRuleUpdate) *UpdateSafetyRuleInput {
+ s.GatingRuleUpdate = v
+ return s
+}
+
+// The result of a successful UpdateSafetyRule request.
+type UpdateSafetyRuleOutput struct {
+ _ struct{} `type:"structure"`
+
+ // 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.
+ AssertionRule *AssertionRule `type:"structure"`
+
+ // 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.
+ GatingRule *GatingRule `type:"structure"`
+}
+
+// String returns the string representation
+func (s UpdateSafetyRuleOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateSafetyRuleOutput) GoString() string {
+ return s.String()
+}
+
+// SetAssertionRule sets the AssertionRule field's value.
+func (s *UpdateSafetyRuleOutput) SetAssertionRule(v *AssertionRule) *UpdateSafetyRuleOutput {
+ s.AssertionRule = v
+ return s
+}
+
+// SetGatingRule sets the GatingRule field's value.
+func (s *UpdateSafetyRuleOutput) SetGatingRule(v *GatingRule) *UpdateSafetyRuleOutput {
+ s.GatingRule = v
+ return s
+}
+
+// 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.
+type ValidationException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ValidationException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ValidationException) GoString() string {
+ return s.String()
+}
+
+func newErrorValidationException(v protocol.ResponseMetadata) error {
+ return &ValidationException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ValidationException) Code() string {
+ return "ValidationException"
+}
+
+// Message returns the exception's message.
+func (s *ValidationException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ValidationException) OrigErr() error {
+ return nil
+}
+
+func (s *ValidationException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ValidationException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ValidationException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// 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.
+const (
+ // RuleTypeAtleast is a RuleType enum value
+ RuleTypeAtleast = "ATLEAST"
+
+ // RuleTypeAnd is a RuleType enum value
+ RuleTypeAnd = "AND"
+
+ // RuleTypeOr is a RuleType enum value
+ RuleTypeOr = "OR"
+)
+
+// RuleType_Values returns all elements of the RuleType enum
+func RuleType_Values() []string {
+ return []string{
+ RuleTypeAtleast,
+ RuleTypeAnd,
+ RuleTypeOr,
+ }
+}
+
+// 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.
+const (
+ // StatusPending is a Status enum value
+ StatusPending = "PENDING"
+
+ // StatusDeployed is a Status enum value
+ StatusDeployed = "DEPLOYED"
+
+ // StatusPendingDeletion is a Status enum value
+ StatusPendingDeletion = "PENDING_DELETION"
+)
+
+// Status_Values returns all elements of the Status enum
+func Status_Values() []string {
+ return []string{
+ StatusPending,
+ StatusDeployed,
+ StatusPendingDeletion,
+ }
+}
diff --git a/service/route53recoverycontrolconfig/doc.go b/service/route53recoverycontrolconfig/doc.go
new file mode 100644
index 0000000000..76e2d4392f
--- /dev/null
+++ b/service/route53recoverycontrolconfig/doc.go
@@ -0,0 +1,29 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoverycontrolconfig provides the client and types for making API
+// requests to AWS Route53 Recovery Control Config.
+//
+// Recovery Control Configuration API Reference for Amazon Route 53 Application
+// Recovery Controller
+//
+// See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02 for more information on this service.
+//
+// See route53recoverycontrolconfig package documentation for more information.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycontrolconfig/
+//
+// Using the Client
+//
+// To contact AWS Route53 Recovery Control Config with the SDK use the New function to create
+// a new service client. With that client you can make API requests to the service.
+// These clients are safe to use concurrently.
+//
+// See the SDK's documentation for more information on how to use the SDK.
+// https://docs.aws.amazon.com/sdk-for-go/api/
+//
+// See aws.Config documentation for more information on configuring SDK clients.
+// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
+//
+// See the AWS Route53 Recovery Control Config client Route53RecoveryControlConfig for more
+// information on creating client for this service.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoverycontrolconfig/#New
+package route53recoverycontrolconfig
diff --git a/service/route53recoverycontrolconfig/errors.go b/service/route53recoverycontrolconfig/errors.go
new file mode 100644
index 0000000000..7f44569129
--- /dev/null
+++ b/service/route53recoverycontrolconfig/errors.go
@@ -0,0 +1,65 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycontrolconfig
+
+import (
+ "github.com/aws/aws-sdk-go/private/protocol"
+)
+
+const (
+
+ // ErrCodeAccessDeniedException for service response error code
+ // "AccessDeniedException".
+ //
+ // 403 response - AccessDeniedException. You do not have sufficient access to
+ // perform this action.
+ ErrCodeAccessDeniedException = "AccessDeniedException"
+
+ // ErrCodeConflictException for service response error code
+ // "ConflictException".
+ //
+ // 409 response - ConflictException.
+ ErrCodeConflictException = "ConflictException"
+
+ // ErrCodeInternalServerException for service response error code
+ // "InternalServerException".
+ //
+ // 500 response - InternalServiceError. Temporary service error. Retry the request.
+ ErrCodeInternalServerException = "InternalServerException"
+
+ // ErrCodeResourceNotFoundException for service response error code
+ // "ResourceNotFoundException".
+ //
+ // 404 response - The query string contains a syntax error or resource not found.
+ ErrCodeResourceNotFoundException = "ResourceNotFoundException"
+
+ // ErrCodeServiceQuotaExceededException for service response error code
+ // "ServiceQuotaExceededException".
+ //
+ // 402 response
+ ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"
+
+ // ErrCodeThrottlingException for service response error code
+ // "ThrottlingException".
+ //
+ // 429 response - ThrottlingException.
+ ErrCodeThrottlingException = "ThrottlingException"
+
+ // ErrCodeValidationException for service response error code
+ // "ValidationException".
+ //
+ // 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.
+ ErrCodeValidationException = "ValidationException"
+)
+
+var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{
+ "AccessDeniedException": newErrorAccessDeniedException,
+ "ConflictException": newErrorConflictException,
+ "InternalServerException": newErrorInternalServerException,
+ "ResourceNotFoundException": newErrorResourceNotFoundException,
+ "ServiceQuotaExceededException": newErrorServiceQuotaExceededException,
+ "ThrottlingException": newErrorThrottlingException,
+ "ValidationException": newErrorValidationException,
+}
diff --git a/service/route53recoverycontrolconfig/route53recoverycontrolconfigiface/interface.go b/service/route53recoverycontrolconfig/route53recoverycontrolconfigiface/interface.go
new file mode 100644
index 0000000000..31fffc90cf
--- /dev/null
+++ b/service/route53recoverycontrolconfig/route53recoverycontrolconfigiface/interface.go
@@ -0,0 +1,177 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoverycontrolconfigiface provides an interface to enable mocking the AWS Route53 Recovery Control Config service client
+// for testing your code.
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters.
+package route53recoverycontrolconfigiface
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/service/route53recoverycontrolconfig"
+)
+
+// Route53RecoveryControlConfigAPI provides an interface to enable mocking the
+// route53recoverycontrolconfig.Route53RecoveryControlConfig service client's API operation,
+// paginators, and waiters. This make unit testing your code that calls out
+// to the SDK's service client's calls easier.
+//
+// The best way to use this interface is so the SDK's service client's calls
+// can be stubbed out for unit testing your code with the SDK without needing
+// to inject custom request handlers into the SDK's request pipeline.
+//
+// // myFunc uses an SDK service client to make a request to
+// // AWS Route53 Recovery Control Config.
+// func myFunc(svc route53recoverycontrolconfigiface.Route53RecoveryControlConfigAPI) bool {
+// // Make svc.CreateCluster request
+// }
+//
+// func main() {
+// sess := session.New()
+// svc := route53recoverycontrolconfig.New(sess)
+//
+// myFunc(svc)
+// }
+//
+// In your _test.go file:
+//
+// // Define a mock struct to be used in your unit tests of myFunc.
+// type mockRoute53RecoveryControlConfigClient struct {
+// route53recoverycontrolconfigiface.Route53RecoveryControlConfigAPI
+// }
+// func (m *mockRoute53RecoveryControlConfigClient) CreateCluster(input *route53recoverycontrolconfig.CreateClusterInput) (*route53recoverycontrolconfig.CreateClusterOutput, error) {
+// // mock response/functionality
+// }
+//
+// func TestMyFunc(t *testing.T) {
+// // Setup Test
+// mockSvc := &mockRoute53RecoveryControlConfigClient{}
+//
+// myfunc(mockSvc)
+//
+// // Verify myFunc's functionality
+// }
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters. Its suggested to use the pattern above for testing, or using
+// tooling to generate mocks to satisfy the interfaces.
+type Route53RecoveryControlConfigAPI interface {
+ CreateCluster(*route53recoverycontrolconfig.CreateClusterInput) (*route53recoverycontrolconfig.CreateClusterOutput, error)
+ CreateClusterWithContext(aws.Context, *route53recoverycontrolconfig.CreateClusterInput, ...request.Option) (*route53recoverycontrolconfig.CreateClusterOutput, error)
+ CreateClusterRequest(*route53recoverycontrolconfig.CreateClusterInput) (*request.Request, *route53recoverycontrolconfig.CreateClusterOutput)
+
+ CreateControlPanel(*route53recoverycontrolconfig.CreateControlPanelInput) (*route53recoverycontrolconfig.CreateControlPanelOutput, error)
+ CreateControlPanelWithContext(aws.Context, *route53recoverycontrolconfig.CreateControlPanelInput, ...request.Option) (*route53recoverycontrolconfig.CreateControlPanelOutput, error)
+ CreateControlPanelRequest(*route53recoverycontrolconfig.CreateControlPanelInput) (*request.Request, *route53recoverycontrolconfig.CreateControlPanelOutput)
+
+ CreateRoutingControl(*route53recoverycontrolconfig.CreateRoutingControlInput) (*route53recoverycontrolconfig.CreateRoutingControlOutput, error)
+ CreateRoutingControlWithContext(aws.Context, *route53recoverycontrolconfig.CreateRoutingControlInput, ...request.Option) (*route53recoverycontrolconfig.CreateRoutingControlOutput, error)
+ CreateRoutingControlRequest(*route53recoverycontrolconfig.CreateRoutingControlInput) (*request.Request, *route53recoverycontrolconfig.CreateRoutingControlOutput)
+
+ CreateSafetyRule(*route53recoverycontrolconfig.CreateSafetyRuleInput) (*route53recoverycontrolconfig.CreateSafetyRuleOutput, error)
+ CreateSafetyRuleWithContext(aws.Context, *route53recoverycontrolconfig.CreateSafetyRuleInput, ...request.Option) (*route53recoverycontrolconfig.CreateSafetyRuleOutput, error)
+ CreateSafetyRuleRequest(*route53recoverycontrolconfig.CreateSafetyRuleInput) (*request.Request, *route53recoverycontrolconfig.CreateSafetyRuleOutput)
+
+ DeleteCluster(*route53recoverycontrolconfig.DeleteClusterInput) (*route53recoverycontrolconfig.DeleteClusterOutput, error)
+ DeleteClusterWithContext(aws.Context, *route53recoverycontrolconfig.DeleteClusterInput, ...request.Option) (*route53recoverycontrolconfig.DeleteClusterOutput, error)
+ DeleteClusterRequest(*route53recoverycontrolconfig.DeleteClusterInput) (*request.Request, *route53recoverycontrolconfig.DeleteClusterOutput)
+
+ DeleteControlPanel(*route53recoverycontrolconfig.DeleteControlPanelInput) (*route53recoverycontrolconfig.DeleteControlPanelOutput, error)
+ DeleteControlPanelWithContext(aws.Context, *route53recoverycontrolconfig.DeleteControlPanelInput, ...request.Option) (*route53recoverycontrolconfig.DeleteControlPanelOutput, error)
+ DeleteControlPanelRequest(*route53recoverycontrolconfig.DeleteControlPanelInput) (*request.Request, *route53recoverycontrolconfig.DeleteControlPanelOutput)
+
+ DeleteRoutingControl(*route53recoverycontrolconfig.DeleteRoutingControlInput) (*route53recoverycontrolconfig.DeleteRoutingControlOutput, error)
+ DeleteRoutingControlWithContext(aws.Context, *route53recoverycontrolconfig.DeleteRoutingControlInput, ...request.Option) (*route53recoverycontrolconfig.DeleteRoutingControlOutput, error)
+ DeleteRoutingControlRequest(*route53recoverycontrolconfig.DeleteRoutingControlInput) (*request.Request, *route53recoverycontrolconfig.DeleteRoutingControlOutput)
+
+ DeleteSafetyRule(*route53recoverycontrolconfig.DeleteSafetyRuleInput) (*route53recoverycontrolconfig.DeleteSafetyRuleOutput, error)
+ DeleteSafetyRuleWithContext(aws.Context, *route53recoverycontrolconfig.DeleteSafetyRuleInput, ...request.Option) (*route53recoverycontrolconfig.DeleteSafetyRuleOutput, error)
+ DeleteSafetyRuleRequest(*route53recoverycontrolconfig.DeleteSafetyRuleInput) (*request.Request, *route53recoverycontrolconfig.DeleteSafetyRuleOutput)
+
+ DescribeCluster(*route53recoverycontrolconfig.DescribeClusterInput) (*route53recoverycontrolconfig.DescribeClusterOutput, error)
+ DescribeClusterWithContext(aws.Context, *route53recoverycontrolconfig.DescribeClusterInput, ...request.Option) (*route53recoverycontrolconfig.DescribeClusterOutput, error)
+ DescribeClusterRequest(*route53recoverycontrolconfig.DescribeClusterInput) (*request.Request, *route53recoverycontrolconfig.DescribeClusterOutput)
+
+ DescribeControlPanel(*route53recoverycontrolconfig.DescribeControlPanelInput) (*route53recoverycontrolconfig.DescribeControlPanelOutput, error)
+ DescribeControlPanelWithContext(aws.Context, *route53recoverycontrolconfig.DescribeControlPanelInput, ...request.Option) (*route53recoverycontrolconfig.DescribeControlPanelOutput, error)
+ DescribeControlPanelRequest(*route53recoverycontrolconfig.DescribeControlPanelInput) (*request.Request, *route53recoverycontrolconfig.DescribeControlPanelOutput)
+
+ DescribeRoutingControl(*route53recoverycontrolconfig.DescribeRoutingControlInput) (*route53recoverycontrolconfig.DescribeRoutingControlOutput, error)
+ DescribeRoutingControlWithContext(aws.Context, *route53recoverycontrolconfig.DescribeRoutingControlInput, ...request.Option) (*route53recoverycontrolconfig.DescribeRoutingControlOutput, error)
+ DescribeRoutingControlRequest(*route53recoverycontrolconfig.DescribeRoutingControlInput) (*request.Request, *route53recoverycontrolconfig.DescribeRoutingControlOutput)
+
+ DescribeSafetyRule(*route53recoverycontrolconfig.DescribeSafetyRuleInput) (*route53recoverycontrolconfig.DescribeSafetyRuleOutput, error)
+ DescribeSafetyRuleWithContext(aws.Context, *route53recoverycontrolconfig.DescribeSafetyRuleInput, ...request.Option) (*route53recoverycontrolconfig.DescribeSafetyRuleOutput, error)
+ DescribeSafetyRuleRequest(*route53recoverycontrolconfig.DescribeSafetyRuleInput) (*request.Request, *route53recoverycontrolconfig.DescribeSafetyRuleOutput)
+
+ ListAssociatedRoute53HealthChecks(*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksInput) (*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput, error)
+ ListAssociatedRoute53HealthChecksWithContext(aws.Context, *route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksInput, ...request.Option) (*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput, error)
+ ListAssociatedRoute53HealthChecksRequest(*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksInput) (*request.Request, *route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput)
+
+ ListAssociatedRoute53HealthChecksPages(*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksInput, func(*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput, bool) bool) error
+ ListAssociatedRoute53HealthChecksPagesWithContext(aws.Context, *route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksInput, func(*route53recoverycontrolconfig.ListAssociatedRoute53HealthChecksOutput, bool) bool, ...request.Option) error
+
+ ListClusters(*route53recoverycontrolconfig.ListClustersInput) (*route53recoverycontrolconfig.ListClustersOutput, error)
+ ListClustersWithContext(aws.Context, *route53recoverycontrolconfig.ListClustersInput, ...request.Option) (*route53recoverycontrolconfig.ListClustersOutput, error)
+ ListClustersRequest(*route53recoverycontrolconfig.ListClustersInput) (*request.Request, *route53recoverycontrolconfig.ListClustersOutput)
+
+ ListClustersPages(*route53recoverycontrolconfig.ListClustersInput, func(*route53recoverycontrolconfig.ListClustersOutput, bool) bool) error
+ ListClustersPagesWithContext(aws.Context, *route53recoverycontrolconfig.ListClustersInput, func(*route53recoverycontrolconfig.ListClustersOutput, bool) bool, ...request.Option) error
+
+ ListControlPanels(*route53recoverycontrolconfig.ListControlPanelsInput) (*route53recoverycontrolconfig.ListControlPanelsOutput, error)
+ ListControlPanelsWithContext(aws.Context, *route53recoverycontrolconfig.ListControlPanelsInput, ...request.Option) (*route53recoverycontrolconfig.ListControlPanelsOutput, error)
+ ListControlPanelsRequest(*route53recoverycontrolconfig.ListControlPanelsInput) (*request.Request, *route53recoverycontrolconfig.ListControlPanelsOutput)
+
+ ListControlPanelsPages(*route53recoverycontrolconfig.ListControlPanelsInput, func(*route53recoverycontrolconfig.ListControlPanelsOutput, bool) bool) error
+ ListControlPanelsPagesWithContext(aws.Context, *route53recoverycontrolconfig.ListControlPanelsInput, func(*route53recoverycontrolconfig.ListControlPanelsOutput, bool) bool, ...request.Option) error
+
+ ListRoutingControls(*route53recoverycontrolconfig.ListRoutingControlsInput) (*route53recoverycontrolconfig.ListRoutingControlsOutput, error)
+ ListRoutingControlsWithContext(aws.Context, *route53recoverycontrolconfig.ListRoutingControlsInput, ...request.Option) (*route53recoverycontrolconfig.ListRoutingControlsOutput, error)
+ ListRoutingControlsRequest(*route53recoverycontrolconfig.ListRoutingControlsInput) (*request.Request, *route53recoverycontrolconfig.ListRoutingControlsOutput)
+
+ ListRoutingControlsPages(*route53recoverycontrolconfig.ListRoutingControlsInput, func(*route53recoverycontrolconfig.ListRoutingControlsOutput, bool) bool) error
+ ListRoutingControlsPagesWithContext(aws.Context, *route53recoverycontrolconfig.ListRoutingControlsInput, func(*route53recoverycontrolconfig.ListRoutingControlsOutput, bool) bool, ...request.Option) error
+
+ ListSafetyRules(*route53recoverycontrolconfig.ListSafetyRulesInput) (*route53recoverycontrolconfig.ListSafetyRulesOutput, error)
+ ListSafetyRulesWithContext(aws.Context, *route53recoverycontrolconfig.ListSafetyRulesInput, ...request.Option) (*route53recoverycontrolconfig.ListSafetyRulesOutput, error)
+ ListSafetyRulesRequest(*route53recoverycontrolconfig.ListSafetyRulesInput) (*request.Request, *route53recoverycontrolconfig.ListSafetyRulesOutput)
+
+ ListSafetyRulesPages(*route53recoverycontrolconfig.ListSafetyRulesInput, func(*route53recoverycontrolconfig.ListSafetyRulesOutput, bool) bool) error
+ ListSafetyRulesPagesWithContext(aws.Context, *route53recoverycontrolconfig.ListSafetyRulesInput, func(*route53recoverycontrolconfig.ListSafetyRulesOutput, bool) bool, ...request.Option) error
+
+ UpdateControlPanel(*route53recoverycontrolconfig.UpdateControlPanelInput) (*route53recoverycontrolconfig.UpdateControlPanelOutput, error)
+ UpdateControlPanelWithContext(aws.Context, *route53recoverycontrolconfig.UpdateControlPanelInput, ...request.Option) (*route53recoverycontrolconfig.UpdateControlPanelOutput, error)
+ UpdateControlPanelRequest(*route53recoverycontrolconfig.UpdateControlPanelInput) (*request.Request, *route53recoverycontrolconfig.UpdateControlPanelOutput)
+
+ UpdateRoutingControl(*route53recoverycontrolconfig.UpdateRoutingControlInput) (*route53recoverycontrolconfig.UpdateRoutingControlOutput, error)
+ UpdateRoutingControlWithContext(aws.Context, *route53recoverycontrolconfig.UpdateRoutingControlInput, ...request.Option) (*route53recoverycontrolconfig.UpdateRoutingControlOutput, error)
+ UpdateRoutingControlRequest(*route53recoverycontrolconfig.UpdateRoutingControlInput) (*request.Request, *route53recoverycontrolconfig.UpdateRoutingControlOutput)
+
+ UpdateSafetyRule(*route53recoverycontrolconfig.UpdateSafetyRuleInput) (*route53recoverycontrolconfig.UpdateSafetyRuleOutput, error)
+ UpdateSafetyRuleWithContext(aws.Context, *route53recoverycontrolconfig.UpdateSafetyRuleInput, ...request.Option) (*route53recoverycontrolconfig.UpdateSafetyRuleOutput, error)
+ UpdateSafetyRuleRequest(*route53recoverycontrolconfig.UpdateSafetyRuleInput) (*request.Request, *route53recoverycontrolconfig.UpdateSafetyRuleOutput)
+
+ WaitUntilClusterCreated(*route53recoverycontrolconfig.DescribeClusterInput) error
+ WaitUntilClusterCreatedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeClusterInput, ...request.WaiterOption) error
+
+ WaitUntilClusterDeleted(*route53recoverycontrolconfig.DescribeClusterInput) error
+ WaitUntilClusterDeletedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeClusterInput, ...request.WaiterOption) error
+
+ WaitUntilControlPanelCreated(*route53recoverycontrolconfig.DescribeControlPanelInput) error
+ WaitUntilControlPanelCreatedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeControlPanelInput, ...request.WaiterOption) error
+
+ WaitUntilControlPanelDeleted(*route53recoverycontrolconfig.DescribeControlPanelInput) error
+ WaitUntilControlPanelDeletedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeControlPanelInput, ...request.WaiterOption) error
+
+ WaitUntilRoutingControlCreated(*route53recoverycontrolconfig.DescribeRoutingControlInput) error
+ WaitUntilRoutingControlCreatedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeRoutingControlInput, ...request.WaiterOption) error
+
+ WaitUntilRoutingControlDeleted(*route53recoverycontrolconfig.DescribeRoutingControlInput) error
+ WaitUntilRoutingControlDeletedWithContext(aws.Context, *route53recoverycontrolconfig.DescribeRoutingControlInput, ...request.WaiterOption) error
+}
+
+var _ Route53RecoveryControlConfigAPI = (*route53recoverycontrolconfig.Route53RecoveryControlConfig)(nil)
diff --git a/service/route53recoverycontrolconfig/service.go b/service/route53recoverycontrolconfig/service.go
new file mode 100644
index 0000000000..41a8010c25
--- /dev/null
+++ b/service/route53recoverycontrolconfig/service.go
@@ -0,0 +1,104 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycontrolconfig
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/client"
+ "github.com/aws/aws-sdk-go/aws/client/metadata"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/aws/signer/v4"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/restjson"
+)
+
+// Route53RecoveryControlConfig provides the API operation methods for making requests to
+// AWS Route53 Recovery Control Config. See this package's package overview docs
+// for details on the service.
+//
+// Route53RecoveryControlConfig methods are safe to use concurrently. It is not safe to
+// modify mutate any of the struct's properties though.
+type Route53RecoveryControlConfig struct {
+ *client.Client
+}
+
+// Used for custom client initialization logic
+var initClient func(*client.Client)
+
+// Used for custom request initialization logic
+var initRequest func(*request.Request)
+
+// Service information constants
+const (
+ ServiceName = "Route53 Recovery Control Config" // Name of service.
+ EndpointsID = "route53-recovery-control-config" // ID to lookup a service endpoint with.
+ ServiceID = "Route53 Recovery Control Config" // ServiceID is a unique identifier of a specific service.
+)
+
+// New creates a new instance of the Route53RecoveryControlConfig client with a session.
+// If additional configuration is needed for the client instance use the optional
+// aws.Config parameter to add your extra config.
+//
+// Example:
+// mySession := session.Must(session.NewSession())
+//
+// // Create a Route53RecoveryControlConfig client from just a session.
+// svc := route53recoverycontrolconfig.New(mySession)
+//
+// // Create a Route53RecoveryControlConfig client with additional configuration
+// svc := route53recoverycontrolconfig.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
+func New(p client.ConfigProvider, cfgs ...*aws.Config) *Route53RecoveryControlConfig {
+ c := p.ClientConfig(EndpointsID, cfgs...)
+ if c.SigningNameDerived || len(c.SigningName) == 0 {
+ c.SigningName = "route53-recovery-control-config"
+ }
+ return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName)
+}
+
+// newClient creates, initializes and returns a new service client instance.
+func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *Route53RecoveryControlConfig {
+ svc := &Route53RecoveryControlConfig{
+ Client: client.New(
+ cfg,
+ metadata.ClientInfo{
+ ServiceName: ServiceName,
+ ServiceID: ServiceID,
+ SigningName: signingName,
+ SigningRegion: signingRegion,
+ PartitionID: partitionID,
+ Endpoint: endpoint,
+ APIVersion: "2020-11-02",
+ },
+ handlers,
+ ),
+ }
+
+ // Handlers
+ svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler)
+ svc.Handlers.Build.PushBackNamed(restjson.BuildHandler)
+ svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler)
+ svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler)
+ svc.Handlers.UnmarshalError.PushBackNamed(
+ protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(),
+ )
+
+ // Run custom client initialization if present
+ if initClient != nil {
+ initClient(svc.Client)
+ }
+
+ return svc
+}
+
+// newRequest creates a new request for a Route53RecoveryControlConfig operation and runs any
+// custom request initialization.
+func (c *Route53RecoveryControlConfig) newRequest(op *request.Operation, params, data interface{}) *request.Request {
+ req := c.NewRequest(op, params, data)
+
+ // Run custom request initialization if present
+ if initRequest != nil {
+ initRequest(req)
+ }
+
+ return req
+}
diff --git a/service/route53recoverycontrolconfig/waiters.go b/service/route53recoverycontrolconfig/waiters.go
new file mode 100644
index 0000000000..0eb5bdec2c
--- /dev/null
+++ b/service/route53recoverycontrolconfig/waiters.go
@@ -0,0 +1,346 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoverycontrolconfig
+
+import (
+ "time"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/request"
+)
+
+// WaitUntilClusterCreated uses the AWS Route53 Recovery Control Config API operation
+// DescribeCluster to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilClusterCreated(input *DescribeClusterInput) error {
+ return c.WaitUntilClusterCreatedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilClusterCreatedWithContext is an extended version of WaitUntilClusterCreated.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilClusterCreatedWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilClusterCreated",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "Cluster.Status",
+ Expected: "DEPLOYED",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "Cluster.Status",
+ Expected: "PENDING",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeClusterInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeClusterRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilClusterDeleted uses the AWS Route53 Recovery Control Config API operation
+// DescribeCluster to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilClusterDeleted(input *DescribeClusterInput) error {
+ return c.WaitUntilClusterDeletedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilClusterDeletedWithContext is an extended version of WaitUntilClusterDeleted.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilClusterDeletedWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilClusterDeleted",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 404,
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "Cluster.Status",
+ Expected: "PENDING_DELETION",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeClusterInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeClusterRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilControlPanelCreated uses the AWS Route53 Recovery Control Config API operation
+// DescribeControlPanel to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilControlPanelCreated(input *DescribeControlPanelInput) error {
+ return c.WaitUntilControlPanelCreatedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilControlPanelCreatedWithContext is an extended version of WaitUntilControlPanelCreated.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilControlPanelCreatedWithContext(ctx aws.Context, input *DescribeControlPanelInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilControlPanelCreated",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "ControlPanel.Status",
+ Expected: "DEPLOYED",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "ControlPanel.Status",
+ Expected: "PENDING",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeControlPanelInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeControlPanelRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilControlPanelDeleted uses the AWS Route53 Recovery Control Config API operation
+// DescribeControlPanel to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilControlPanelDeleted(input *DescribeControlPanelInput) error {
+ return c.WaitUntilControlPanelDeletedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilControlPanelDeletedWithContext is an extended version of WaitUntilControlPanelDeleted.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilControlPanelDeletedWithContext(ctx aws.Context, input *DescribeControlPanelInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilControlPanelDeleted",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 404,
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "ControlPanel.Status",
+ Expected: "PENDING_DELETION",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeControlPanelInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeControlPanelRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilRoutingControlCreated uses the AWS Route53 Recovery Control Config API operation
+// DescribeRoutingControl to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilRoutingControlCreated(input *DescribeRoutingControlInput) error {
+ return c.WaitUntilRoutingControlCreatedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilRoutingControlCreatedWithContext is an extended version of WaitUntilRoutingControlCreated.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilRoutingControlCreatedWithContext(ctx aws.Context, input *DescribeRoutingControlInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilRoutingControlCreated",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "RoutingControl.Status",
+ Expected: "DEPLOYED",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "RoutingControl.Status",
+ Expected: "PENDING",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeRoutingControlInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeRoutingControlRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
+
+// WaitUntilRoutingControlDeleted uses the AWS Route53 Recovery Control Config API operation
+// DescribeRoutingControl to wait for a condition to be met before returning.
+// If the condition is not met within the max attempt window, an error will
+// be returned.
+func (c *Route53RecoveryControlConfig) WaitUntilRoutingControlDeleted(input *DescribeRoutingControlInput) error {
+ return c.WaitUntilRoutingControlDeletedWithContext(aws.BackgroundContext(), input)
+}
+
+// WaitUntilRoutingControlDeletedWithContext is an extended version of WaitUntilRoutingControlDeleted.
+// With the support for passing in a context and options to configure the
+// Waiter and the underlying request options.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryControlConfig) WaitUntilRoutingControlDeletedWithContext(ctx aws.Context, input *DescribeRoutingControlInput, opts ...request.WaiterOption) error {
+ w := request.Waiter{
+ Name: "WaitUntilRoutingControlDeleted",
+ MaxAttempts: 26,
+ Delay: request.ConstantWaiterDelay(5 * time.Second),
+ Acceptors: []request.WaiterAcceptor{
+ {
+ State: request.SuccessWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 404,
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.PathWaiterMatch, Argument: "RoutingControl.Status",
+ Expected: "PENDING_DELETION",
+ },
+ {
+ State: request.RetryWaiterState,
+ Matcher: request.StatusWaiterMatch,
+ Expected: 500,
+ },
+ },
+ Logger: c.Config.Logger,
+ NewRequest: func(opts []request.Option) (*request.Request, error) {
+ var inCpy *DescribeRoutingControlInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.DescribeRoutingControlRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+ w.ApplyOptions(opts...)
+
+ return w.WaitWithContext(ctx)
+}
diff --git a/service/route53recoveryreadiness/api.go b/service/route53recoveryreadiness/api.go
new file mode 100644
index 0000000000..b1ccc2ae09
--- /dev/null
+++ b/service/route53recoveryreadiness/api.go
@@ -0,0 +1,7078 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoveryreadiness
+
+import (
+ "fmt"
+ "time"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/awsutil"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/restjson"
+)
+
+const opCreateCell = "CreateCell"
+
+// CreateCellRequest generates a "aws/request.Request" representing the
+// client's request for the CreateCell operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateCell for more information on using the CreateCell
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateCellRequest method.
+// req, resp := client.CreateCellRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateCell
+func (c *Route53RecoveryReadiness) CreateCellRequest(input *CreateCellInput) (req *request.Request, output *CreateCellOutput) {
+ op := &request.Operation{
+ Name: opCreateCell,
+ HTTPMethod: "POST",
+ HTTPPath: "/cells",
+ }
+
+ if input == nil {
+ input = &CreateCellInput{}
+ }
+
+ output = &CreateCellOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateCell API operation for AWS Route53 Recovery Readiness.
+//
+// Creates a new Cell.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation CreateCell for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * ConflictException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateCell
+func (c *Route53RecoveryReadiness) CreateCell(input *CreateCellInput) (*CreateCellOutput, error) {
+ req, out := c.CreateCellRequest(input)
+ return out, req.Send()
+}
+
+// CreateCellWithContext is the same as CreateCell with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateCell for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) CreateCellWithContext(ctx aws.Context, input *CreateCellInput, opts ...request.Option) (*CreateCellOutput, error) {
+ req, out := c.CreateCellRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateCrossAccountAuthorization = "CreateCrossAccountAuthorization"
+
+// CreateCrossAccountAuthorizationRequest generates a "aws/request.Request" representing the
+// client's request for the CreateCrossAccountAuthorization operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateCrossAccountAuthorization for more information on using the CreateCrossAccountAuthorization
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateCrossAccountAuthorizationRequest method.
+// req, resp := client.CreateCrossAccountAuthorizationRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateCrossAccountAuthorization
+func (c *Route53RecoveryReadiness) CreateCrossAccountAuthorizationRequest(input *CreateCrossAccountAuthorizationInput) (req *request.Request, output *CreateCrossAccountAuthorizationOutput) {
+ op := &request.Operation{
+ Name: opCreateCrossAccountAuthorization,
+ HTTPMethod: "POST",
+ HTTPPath: "/crossaccountauthorizations",
+ }
+
+ if input == nil {
+ input = &CreateCrossAccountAuthorizationInput{}
+ }
+
+ output = &CreateCrossAccountAuthorizationOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateCrossAccountAuthorization API operation for AWS Route53 Recovery Readiness.
+//
+// Create a new cross account readiness authorization.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation CreateCrossAccountAuthorization for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * ConflictException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateCrossAccountAuthorization
+func (c *Route53RecoveryReadiness) CreateCrossAccountAuthorization(input *CreateCrossAccountAuthorizationInput) (*CreateCrossAccountAuthorizationOutput, error) {
+ req, out := c.CreateCrossAccountAuthorizationRequest(input)
+ return out, req.Send()
+}
+
+// CreateCrossAccountAuthorizationWithContext is the same as CreateCrossAccountAuthorization with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateCrossAccountAuthorization for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) CreateCrossAccountAuthorizationWithContext(ctx aws.Context, input *CreateCrossAccountAuthorizationInput, opts ...request.Option) (*CreateCrossAccountAuthorizationOutput, error) {
+ req, out := c.CreateCrossAccountAuthorizationRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateReadinessCheck = "CreateReadinessCheck"
+
+// CreateReadinessCheckRequest generates a "aws/request.Request" representing the
+// client's request for the CreateReadinessCheck operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateReadinessCheck for more information on using the CreateReadinessCheck
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateReadinessCheckRequest method.
+// req, resp := client.CreateReadinessCheckRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateReadinessCheck
+func (c *Route53RecoveryReadiness) CreateReadinessCheckRequest(input *CreateReadinessCheckInput) (req *request.Request, output *CreateReadinessCheckOutput) {
+ op := &request.Operation{
+ Name: opCreateReadinessCheck,
+ HTTPMethod: "POST",
+ HTTPPath: "/readinesschecks",
+ }
+
+ if input == nil {
+ input = &CreateReadinessCheckInput{}
+ }
+
+ output = &CreateReadinessCheckOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateReadinessCheck API operation for AWS Route53 Recovery Readiness.
+//
+// Creates a new Readiness Check.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation CreateReadinessCheck for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * ConflictException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateReadinessCheck
+func (c *Route53RecoveryReadiness) CreateReadinessCheck(input *CreateReadinessCheckInput) (*CreateReadinessCheckOutput, error) {
+ req, out := c.CreateReadinessCheckRequest(input)
+ return out, req.Send()
+}
+
+// CreateReadinessCheckWithContext is the same as CreateReadinessCheck with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateReadinessCheck for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) CreateReadinessCheckWithContext(ctx aws.Context, input *CreateReadinessCheckInput, opts ...request.Option) (*CreateReadinessCheckOutput, error) {
+ req, out := c.CreateReadinessCheckRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateRecoveryGroup = "CreateRecoveryGroup"
+
+// CreateRecoveryGroupRequest generates a "aws/request.Request" representing the
+// client's request for the CreateRecoveryGroup operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateRecoveryGroup for more information on using the CreateRecoveryGroup
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateRecoveryGroupRequest method.
+// req, resp := client.CreateRecoveryGroupRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateRecoveryGroup
+func (c *Route53RecoveryReadiness) CreateRecoveryGroupRequest(input *CreateRecoveryGroupInput) (req *request.Request, output *CreateRecoveryGroupOutput) {
+ op := &request.Operation{
+ Name: opCreateRecoveryGroup,
+ HTTPMethod: "POST",
+ HTTPPath: "/recoverygroups",
+ }
+
+ if input == nil {
+ input = &CreateRecoveryGroupInput{}
+ }
+
+ output = &CreateRecoveryGroupOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateRecoveryGroup API operation for AWS Route53 Recovery Readiness.
+//
+// Creates a new Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation CreateRecoveryGroup for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * ConflictException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateRecoveryGroup
+func (c *Route53RecoveryReadiness) CreateRecoveryGroup(input *CreateRecoveryGroupInput) (*CreateRecoveryGroupOutput, error) {
+ req, out := c.CreateRecoveryGroupRequest(input)
+ return out, req.Send()
+}
+
+// CreateRecoveryGroupWithContext is the same as CreateRecoveryGroup with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateRecoveryGroup for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) CreateRecoveryGroupWithContext(ctx aws.Context, input *CreateRecoveryGroupInput, opts ...request.Option) (*CreateRecoveryGroupOutput, error) {
+ req, out := c.CreateRecoveryGroupRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opCreateResourceSet = "CreateResourceSet"
+
+// CreateResourceSetRequest generates a "aws/request.Request" representing the
+// client's request for the CreateResourceSet operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See CreateResourceSet for more information on using the CreateResourceSet
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the CreateResourceSetRequest method.
+// req, resp := client.CreateResourceSetRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateResourceSet
+func (c *Route53RecoveryReadiness) CreateResourceSetRequest(input *CreateResourceSetInput) (req *request.Request, output *CreateResourceSetOutput) {
+ op := &request.Operation{
+ Name: opCreateResourceSet,
+ HTTPMethod: "POST",
+ HTTPPath: "/resourcesets",
+ }
+
+ if input == nil {
+ input = &CreateResourceSetInput{}
+ }
+
+ output = &CreateResourceSetOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// CreateResourceSet API operation for AWS Route53 Recovery Readiness.
+//
+// Creates a new Resource Set.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation CreateResourceSet for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * ConflictException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/CreateResourceSet
+func (c *Route53RecoveryReadiness) CreateResourceSet(input *CreateResourceSetInput) (*CreateResourceSetOutput, error) {
+ req, out := c.CreateResourceSetRequest(input)
+ return out, req.Send()
+}
+
+// CreateResourceSetWithContext is the same as CreateResourceSet with the addition of
+// the ability to pass a context and additional request options.
+//
+// See CreateResourceSet for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) CreateResourceSetWithContext(ctx aws.Context, input *CreateResourceSetInput, opts ...request.Option) (*CreateResourceSetOutput, error) {
+ req, out := c.CreateResourceSetRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteCell = "DeleteCell"
+
+// DeleteCellRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteCell operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteCell for more information on using the DeleteCell
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteCellRequest method.
+// req, resp := client.DeleteCellRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteCell
+func (c *Route53RecoveryReadiness) DeleteCellRequest(input *DeleteCellInput) (req *request.Request, output *DeleteCellOutput) {
+ op := &request.Operation{
+ Name: opDeleteCell,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/cells/{cellName}",
+ }
+
+ if input == nil {
+ input = &DeleteCellInput{}
+ }
+
+ output = &DeleteCellOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteCell API operation for AWS Route53 Recovery Readiness.
+//
+// Deletes an existing Cell.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation DeleteCell for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteCell
+func (c *Route53RecoveryReadiness) DeleteCell(input *DeleteCellInput) (*DeleteCellOutput, error) {
+ req, out := c.DeleteCellRequest(input)
+ return out, req.Send()
+}
+
+// DeleteCellWithContext is the same as DeleteCell with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteCell for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) DeleteCellWithContext(ctx aws.Context, input *DeleteCellInput, opts ...request.Option) (*DeleteCellOutput, error) {
+ req, out := c.DeleteCellRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteCrossAccountAuthorization = "DeleteCrossAccountAuthorization"
+
+// DeleteCrossAccountAuthorizationRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteCrossAccountAuthorization operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteCrossAccountAuthorization for more information on using the DeleteCrossAccountAuthorization
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteCrossAccountAuthorizationRequest method.
+// req, resp := client.DeleteCrossAccountAuthorizationRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteCrossAccountAuthorization
+func (c *Route53RecoveryReadiness) DeleteCrossAccountAuthorizationRequest(input *DeleteCrossAccountAuthorizationInput) (req *request.Request, output *DeleteCrossAccountAuthorizationOutput) {
+ op := &request.Operation{
+ Name: opDeleteCrossAccountAuthorization,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/crossaccountauthorizations/{crossAccountAuthorization}",
+ }
+
+ if input == nil {
+ input = &DeleteCrossAccountAuthorizationInput{}
+ }
+
+ output = &DeleteCrossAccountAuthorizationOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteCrossAccountAuthorization API operation for AWS Route53 Recovery Readiness.
+//
+// Delete cross account readiness authorization
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation DeleteCrossAccountAuthorization for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteCrossAccountAuthorization
+func (c *Route53RecoveryReadiness) DeleteCrossAccountAuthorization(input *DeleteCrossAccountAuthorizationInput) (*DeleteCrossAccountAuthorizationOutput, error) {
+ req, out := c.DeleteCrossAccountAuthorizationRequest(input)
+ return out, req.Send()
+}
+
+// DeleteCrossAccountAuthorizationWithContext is the same as DeleteCrossAccountAuthorization with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteCrossAccountAuthorization for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) DeleteCrossAccountAuthorizationWithContext(ctx aws.Context, input *DeleteCrossAccountAuthorizationInput, opts ...request.Option) (*DeleteCrossAccountAuthorizationOutput, error) {
+ req, out := c.DeleteCrossAccountAuthorizationRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteReadinessCheck = "DeleteReadinessCheck"
+
+// DeleteReadinessCheckRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteReadinessCheck operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteReadinessCheck for more information on using the DeleteReadinessCheck
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteReadinessCheckRequest method.
+// req, resp := client.DeleteReadinessCheckRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteReadinessCheck
+func (c *Route53RecoveryReadiness) DeleteReadinessCheckRequest(input *DeleteReadinessCheckInput) (req *request.Request, output *DeleteReadinessCheckOutput) {
+ op := &request.Operation{
+ Name: opDeleteReadinessCheck,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/readinesschecks/{readinessCheckName}",
+ }
+
+ if input == nil {
+ input = &DeleteReadinessCheckInput{}
+ }
+
+ output = &DeleteReadinessCheckOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteReadinessCheck API operation for AWS Route53 Recovery Readiness.
+//
+// Deletes an existing Readiness Check.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation DeleteReadinessCheck for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteReadinessCheck
+func (c *Route53RecoveryReadiness) DeleteReadinessCheck(input *DeleteReadinessCheckInput) (*DeleteReadinessCheckOutput, error) {
+ req, out := c.DeleteReadinessCheckRequest(input)
+ return out, req.Send()
+}
+
+// DeleteReadinessCheckWithContext is the same as DeleteReadinessCheck with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteReadinessCheck for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) DeleteReadinessCheckWithContext(ctx aws.Context, input *DeleteReadinessCheckInput, opts ...request.Option) (*DeleteReadinessCheckOutput, error) {
+ req, out := c.DeleteReadinessCheckRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteRecoveryGroup = "DeleteRecoveryGroup"
+
+// DeleteRecoveryGroupRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteRecoveryGroup operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteRecoveryGroup for more information on using the DeleteRecoveryGroup
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteRecoveryGroupRequest method.
+// req, resp := client.DeleteRecoveryGroupRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteRecoveryGroup
+func (c *Route53RecoveryReadiness) DeleteRecoveryGroupRequest(input *DeleteRecoveryGroupInput) (req *request.Request, output *DeleteRecoveryGroupOutput) {
+ op := &request.Operation{
+ Name: opDeleteRecoveryGroup,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/recoverygroups/{recoveryGroupName}",
+ }
+
+ if input == nil {
+ input = &DeleteRecoveryGroupInput{}
+ }
+
+ output = &DeleteRecoveryGroupOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteRecoveryGroup API operation for AWS Route53 Recovery Readiness.
+//
+// Deletes an existing Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation DeleteRecoveryGroup for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteRecoveryGroup
+func (c *Route53RecoveryReadiness) DeleteRecoveryGroup(input *DeleteRecoveryGroupInput) (*DeleteRecoveryGroupOutput, error) {
+ req, out := c.DeleteRecoveryGroupRequest(input)
+ return out, req.Send()
+}
+
+// DeleteRecoveryGroupWithContext is the same as DeleteRecoveryGroup with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteRecoveryGroup for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) DeleteRecoveryGroupWithContext(ctx aws.Context, input *DeleteRecoveryGroupInput, opts ...request.Option) (*DeleteRecoveryGroupOutput, error) {
+ req, out := c.DeleteRecoveryGroupRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opDeleteResourceSet = "DeleteResourceSet"
+
+// DeleteResourceSetRequest generates a "aws/request.Request" representing the
+// client's request for the DeleteResourceSet operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See DeleteResourceSet for more information on using the DeleteResourceSet
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the DeleteResourceSetRequest method.
+// req, resp := client.DeleteResourceSetRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteResourceSet
+func (c *Route53RecoveryReadiness) DeleteResourceSetRequest(input *DeleteResourceSetInput) (req *request.Request, output *DeleteResourceSetOutput) {
+ op := &request.Operation{
+ Name: opDeleteResourceSet,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/resourcesets/{resourceSetName}",
+ }
+
+ if input == nil {
+ input = &DeleteResourceSetInput{}
+ }
+
+ output = &DeleteResourceSetOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// DeleteResourceSet API operation for AWS Route53 Recovery Readiness.
+//
+// Deletes an existing Resource Set.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation DeleteResourceSet for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/DeleteResourceSet
+func (c *Route53RecoveryReadiness) DeleteResourceSet(input *DeleteResourceSetInput) (*DeleteResourceSetOutput, error) {
+ req, out := c.DeleteResourceSetRequest(input)
+ return out, req.Send()
+}
+
+// DeleteResourceSetWithContext is the same as DeleteResourceSet with the addition of
+// the ability to pass a context and additional request options.
+//
+// See DeleteResourceSet for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) DeleteResourceSetWithContext(ctx aws.Context, input *DeleteResourceSetInput, opts ...request.Option) (*DeleteResourceSetOutput, error) {
+ req, out := c.DeleteResourceSetRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGetArchitectureRecommendations = "GetArchitectureRecommendations"
+
+// GetArchitectureRecommendationsRequest generates a "aws/request.Request" representing the
+// client's request for the GetArchitectureRecommendations operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetArchitectureRecommendations for more information on using the GetArchitectureRecommendations
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetArchitectureRecommendationsRequest method.
+// req, resp := client.GetArchitectureRecommendationsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetArchitectureRecommendations
+func (c *Route53RecoveryReadiness) GetArchitectureRecommendationsRequest(input *GetArchitectureRecommendationsInput) (req *request.Request, output *GetArchitectureRecommendationsOutput) {
+ op := &request.Operation{
+ Name: opGetArchitectureRecommendations,
+ HTTPMethod: "GET",
+ HTTPPath: "/recoverygroups/{recoveryGroupName}/architectureRecommendations",
+ }
+
+ if input == nil {
+ input = &GetArchitectureRecommendationsInput{}
+ }
+
+ output = &GetArchitectureRecommendationsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetArchitectureRecommendations API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of recommendations to improve resilliance and readiness
+// check quality for a Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetArchitectureRecommendations for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetArchitectureRecommendations
+func (c *Route53RecoveryReadiness) GetArchitectureRecommendations(input *GetArchitectureRecommendationsInput) (*GetArchitectureRecommendationsOutput, error) {
+ req, out := c.GetArchitectureRecommendationsRequest(input)
+ return out, req.Send()
+}
+
+// GetArchitectureRecommendationsWithContext is the same as GetArchitectureRecommendations with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetArchitectureRecommendations for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetArchitectureRecommendationsWithContext(ctx aws.Context, input *GetArchitectureRecommendationsInput, opts ...request.Option) (*GetArchitectureRecommendationsOutput, error) {
+ req, out := c.GetArchitectureRecommendationsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGetCell = "GetCell"
+
+// GetCellRequest generates a "aws/request.Request" representing the
+// client's request for the GetCell operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetCell for more information on using the GetCell
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetCellRequest method.
+// req, resp := client.GetCellRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetCell
+func (c *Route53RecoveryReadiness) GetCellRequest(input *GetCellInput) (req *request.Request, output *GetCellOutput) {
+ op := &request.Operation{
+ Name: opGetCell,
+ HTTPMethod: "GET",
+ HTTPPath: "/cells/{cellName}",
+ }
+
+ if input == nil {
+ input = &GetCellInput{}
+ }
+
+ output = &GetCellOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetCell API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about a Cell.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetCell for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetCell
+func (c *Route53RecoveryReadiness) GetCell(input *GetCellInput) (*GetCellOutput, error) {
+ req, out := c.GetCellRequest(input)
+ return out, req.Send()
+}
+
+// GetCellWithContext is the same as GetCell with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetCell for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetCellWithContext(ctx aws.Context, input *GetCellInput, opts ...request.Option) (*GetCellOutput, error) {
+ req, out := c.GetCellRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGetCellReadinessSummary = "GetCellReadinessSummary"
+
+// GetCellReadinessSummaryRequest generates a "aws/request.Request" representing the
+// client's request for the GetCellReadinessSummary operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetCellReadinessSummary for more information on using the GetCellReadinessSummary
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetCellReadinessSummaryRequest method.
+// req, resp := client.GetCellReadinessSummaryRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetCellReadinessSummary
+func (c *Route53RecoveryReadiness) GetCellReadinessSummaryRequest(input *GetCellReadinessSummaryInput) (req *request.Request, output *GetCellReadinessSummaryOutput) {
+ op := &request.Operation{
+ Name: opGetCellReadinessSummary,
+ HTTPMethod: "GET",
+ HTTPPath: "/cellreadiness/{cellName}",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &GetCellReadinessSummaryInput{}
+ }
+
+ output = &GetCellReadinessSummaryOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetCellReadinessSummary API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about readiness of a Cell.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetCellReadinessSummary for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetCellReadinessSummary
+func (c *Route53RecoveryReadiness) GetCellReadinessSummary(input *GetCellReadinessSummaryInput) (*GetCellReadinessSummaryOutput, error) {
+ req, out := c.GetCellReadinessSummaryRequest(input)
+ return out, req.Send()
+}
+
+// GetCellReadinessSummaryWithContext is the same as GetCellReadinessSummary with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetCellReadinessSummary for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetCellReadinessSummaryWithContext(ctx aws.Context, input *GetCellReadinessSummaryInput, opts ...request.Option) (*GetCellReadinessSummaryOutput, error) {
+ req, out := c.GetCellReadinessSummaryRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// GetCellReadinessSummaryPages iterates over the pages of a GetCellReadinessSummary operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See GetCellReadinessSummary method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a GetCellReadinessSummary operation.
+// pageNum := 0
+// err := client.GetCellReadinessSummaryPages(params,
+// func(page *route53recoveryreadiness.GetCellReadinessSummaryOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) GetCellReadinessSummaryPages(input *GetCellReadinessSummaryInput, fn func(*GetCellReadinessSummaryOutput, bool) bool) error {
+ return c.GetCellReadinessSummaryPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// GetCellReadinessSummaryPagesWithContext same as GetCellReadinessSummaryPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetCellReadinessSummaryPagesWithContext(ctx aws.Context, input *GetCellReadinessSummaryInput, fn func(*GetCellReadinessSummaryOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *GetCellReadinessSummaryInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.GetCellReadinessSummaryRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*GetCellReadinessSummaryOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opGetReadinessCheck = "GetReadinessCheck"
+
+// GetReadinessCheckRequest generates a "aws/request.Request" representing the
+// client's request for the GetReadinessCheck operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetReadinessCheck for more information on using the GetReadinessCheck
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetReadinessCheckRequest method.
+// req, resp := client.GetReadinessCheckRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheck
+func (c *Route53RecoveryReadiness) GetReadinessCheckRequest(input *GetReadinessCheckInput) (req *request.Request, output *GetReadinessCheckOutput) {
+ op := &request.Operation{
+ Name: opGetReadinessCheck,
+ HTTPMethod: "GET",
+ HTTPPath: "/readinesschecks/{readinessCheckName}",
+ }
+
+ if input == nil {
+ input = &GetReadinessCheckInput{}
+ }
+
+ output = &GetReadinessCheckOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetReadinessCheck API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about a ReadinessCheck.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetReadinessCheck for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheck
+func (c *Route53RecoveryReadiness) GetReadinessCheck(input *GetReadinessCheckInput) (*GetReadinessCheckOutput, error) {
+ req, out := c.GetReadinessCheckRequest(input)
+ return out, req.Send()
+}
+
+// GetReadinessCheckWithContext is the same as GetReadinessCheck with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetReadinessCheck for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetReadinessCheckWithContext(ctx aws.Context, input *GetReadinessCheckInput, opts ...request.Option) (*GetReadinessCheckOutput, error) {
+ req, out := c.GetReadinessCheckRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGetReadinessCheckResourceStatus = "GetReadinessCheckResourceStatus"
+
+// GetReadinessCheckResourceStatusRequest generates a "aws/request.Request" representing the
+// client's request for the GetReadinessCheckResourceStatus operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetReadinessCheckResourceStatus for more information on using the GetReadinessCheckResourceStatus
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetReadinessCheckResourceStatusRequest method.
+// req, resp := client.GetReadinessCheckResourceStatusRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheckResourceStatus
+func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatusRequest(input *GetReadinessCheckResourceStatusInput) (req *request.Request, output *GetReadinessCheckResourceStatusOutput) {
+ op := &request.Operation{
+ Name: opGetReadinessCheckResourceStatus,
+ HTTPMethod: "GET",
+ HTTPPath: "/readinesschecks/{readinessCheckName}/resource/{resourceIdentifier}/status",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &GetReadinessCheckResourceStatusInput{}
+ }
+
+ output = &GetReadinessCheckResourceStatusOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetReadinessCheckResourceStatus API operation for AWS Route53 Recovery Readiness.
+//
+// Returns detailed information about the status of an individual resource within
+// a Readiness Check's Resource Set.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetReadinessCheckResourceStatus for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheckResourceStatus
+func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatus(input *GetReadinessCheckResourceStatusInput) (*GetReadinessCheckResourceStatusOutput, error) {
+ req, out := c.GetReadinessCheckResourceStatusRequest(input)
+ return out, req.Send()
+}
+
+// GetReadinessCheckResourceStatusWithContext is the same as GetReadinessCheckResourceStatus with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetReadinessCheckResourceStatus for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatusWithContext(ctx aws.Context, input *GetReadinessCheckResourceStatusInput, opts ...request.Option) (*GetReadinessCheckResourceStatusOutput, error) {
+ req, out := c.GetReadinessCheckResourceStatusRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// GetReadinessCheckResourceStatusPages iterates over the pages of a GetReadinessCheckResourceStatus operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See GetReadinessCheckResourceStatus method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a GetReadinessCheckResourceStatus operation.
+// pageNum := 0
+// err := client.GetReadinessCheckResourceStatusPages(params,
+// func(page *route53recoveryreadiness.GetReadinessCheckResourceStatusOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatusPages(input *GetReadinessCheckResourceStatusInput, fn func(*GetReadinessCheckResourceStatusOutput, bool) bool) error {
+ return c.GetReadinessCheckResourceStatusPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// GetReadinessCheckResourceStatusPagesWithContext same as GetReadinessCheckResourceStatusPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetReadinessCheckResourceStatusPagesWithContext(ctx aws.Context, input *GetReadinessCheckResourceStatusInput, fn func(*GetReadinessCheckResourceStatusOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *GetReadinessCheckResourceStatusInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.GetReadinessCheckResourceStatusRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*GetReadinessCheckResourceStatusOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opGetReadinessCheckStatus = "GetReadinessCheckStatus"
+
+// GetReadinessCheckStatusRequest generates a "aws/request.Request" representing the
+// client's request for the GetReadinessCheckStatus operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetReadinessCheckStatus for more information on using the GetReadinessCheckStatus
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetReadinessCheckStatusRequest method.
+// req, resp := client.GetReadinessCheckStatusRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheckStatus
+func (c *Route53RecoveryReadiness) GetReadinessCheckStatusRequest(input *GetReadinessCheckStatusInput) (req *request.Request, output *GetReadinessCheckStatusOutput) {
+ op := &request.Operation{
+ Name: opGetReadinessCheckStatus,
+ HTTPMethod: "GET",
+ HTTPPath: "/readinesschecks/{readinessCheckName}/status",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &GetReadinessCheckStatusInput{}
+ }
+
+ output = &GetReadinessCheckStatusOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetReadinessCheckStatus API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about the status of a Readiness Check.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetReadinessCheckStatus for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetReadinessCheckStatus
+func (c *Route53RecoveryReadiness) GetReadinessCheckStatus(input *GetReadinessCheckStatusInput) (*GetReadinessCheckStatusOutput, error) {
+ req, out := c.GetReadinessCheckStatusRequest(input)
+ return out, req.Send()
+}
+
+// GetReadinessCheckStatusWithContext is the same as GetReadinessCheckStatus with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetReadinessCheckStatus for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetReadinessCheckStatusWithContext(ctx aws.Context, input *GetReadinessCheckStatusInput, opts ...request.Option) (*GetReadinessCheckStatusOutput, error) {
+ req, out := c.GetReadinessCheckStatusRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// GetReadinessCheckStatusPages iterates over the pages of a GetReadinessCheckStatus operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See GetReadinessCheckStatus method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a GetReadinessCheckStatus operation.
+// pageNum := 0
+// err := client.GetReadinessCheckStatusPages(params,
+// func(page *route53recoveryreadiness.GetReadinessCheckStatusOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) GetReadinessCheckStatusPages(input *GetReadinessCheckStatusInput, fn func(*GetReadinessCheckStatusOutput, bool) bool) error {
+ return c.GetReadinessCheckStatusPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// GetReadinessCheckStatusPagesWithContext same as GetReadinessCheckStatusPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetReadinessCheckStatusPagesWithContext(ctx aws.Context, input *GetReadinessCheckStatusInput, fn func(*GetReadinessCheckStatusOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *GetReadinessCheckStatusInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.GetReadinessCheckStatusRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*GetReadinessCheckStatusOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opGetRecoveryGroup = "GetRecoveryGroup"
+
+// GetRecoveryGroupRequest generates a "aws/request.Request" representing the
+// client's request for the GetRecoveryGroup operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetRecoveryGroup for more information on using the GetRecoveryGroup
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetRecoveryGroupRequest method.
+// req, resp := client.GetRecoveryGroupRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetRecoveryGroup
+func (c *Route53RecoveryReadiness) GetRecoveryGroupRequest(input *GetRecoveryGroupInput) (req *request.Request, output *GetRecoveryGroupOutput) {
+ op := &request.Operation{
+ Name: opGetRecoveryGroup,
+ HTTPMethod: "GET",
+ HTTPPath: "/recoverygroups/{recoveryGroupName}",
+ }
+
+ if input == nil {
+ input = &GetRecoveryGroupInput{}
+ }
+
+ output = &GetRecoveryGroupOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetRecoveryGroup API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about a Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetRecoveryGroup for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetRecoveryGroup
+func (c *Route53RecoveryReadiness) GetRecoveryGroup(input *GetRecoveryGroupInput) (*GetRecoveryGroupOutput, error) {
+ req, out := c.GetRecoveryGroupRequest(input)
+ return out, req.Send()
+}
+
+// GetRecoveryGroupWithContext is the same as GetRecoveryGroup with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetRecoveryGroup for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetRecoveryGroupWithContext(ctx aws.Context, input *GetRecoveryGroupInput, opts ...request.Option) (*GetRecoveryGroupOutput, error) {
+ req, out := c.GetRecoveryGroupRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opGetRecoveryGroupReadinessSummary = "GetRecoveryGroupReadinessSummary"
+
+// GetRecoveryGroupReadinessSummaryRequest generates a "aws/request.Request" representing the
+// client's request for the GetRecoveryGroupReadinessSummary operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetRecoveryGroupReadinessSummary for more information on using the GetRecoveryGroupReadinessSummary
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetRecoveryGroupReadinessSummaryRequest method.
+// req, resp := client.GetRecoveryGroupReadinessSummaryRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetRecoveryGroupReadinessSummary
+func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummaryRequest(input *GetRecoveryGroupReadinessSummaryInput) (req *request.Request, output *GetRecoveryGroupReadinessSummaryOutput) {
+ op := &request.Operation{
+ Name: opGetRecoveryGroupReadinessSummary,
+ HTTPMethod: "GET",
+ HTTPPath: "/recoverygroupreadiness/{recoveryGroupName}",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &GetRecoveryGroupReadinessSummaryInput{}
+ }
+
+ output = &GetRecoveryGroupReadinessSummaryOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetRecoveryGroupReadinessSummary API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about a Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetRecoveryGroupReadinessSummary for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetRecoveryGroupReadinessSummary
+func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummary(input *GetRecoveryGroupReadinessSummaryInput) (*GetRecoveryGroupReadinessSummaryOutput, error) {
+ req, out := c.GetRecoveryGroupReadinessSummaryRequest(input)
+ return out, req.Send()
+}
+
+// GetRecoveryGroupReadinessSummaryWithContext is the same as GetRecoveryGroupReadinessSummary with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetRecoveryGroupReadinessSummary for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummaryWithContext(ctx aws.Context, input *GetRecoveryGroupReadinessSummaryInput, opts ...request.Option) (*GetRecoveryGroupReadinessSummaryOutput, error) {
+ req, out := c.GetRecoveryGroupReadinessSummaryRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// GetRecoveryGroupReadinessSummaryPages iterates over the pages of a GetRecoveryGroupReadinessSummary operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See GetRecoveryGroupReadinessSummary method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a GetRecoveryGroupReadinessSummary operation.
+// pageNum := 0
+// err := client.GetRecoveryGroupReadinessSummaryPages(params,
+// func(page *route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummaryPages(input *GetRecoveryGroupReadinessSummaryInput, fn func(*GetRecoveryGroupReadinessSummaryOutput, bool) bool) error {
+ return c.GetRecoveryGroupReadinessSummaryPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// GetRecoveryGroupReadinessSummaryPagesWithContext same as GetRecoveryGroupReadinessSummaryPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetRecoveryGroupReadinessSummaryPagesWithContext(ctx aws.Context, input *GetRecoveryGroupReadinessSummaryInput, fn func(*GetRecoveryGroupReadinessSummaryOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *GetRecoveryGroupReadinessSummaryInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.GetRecoveryGroupReadinessSummaryRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*GetRecoveryGroupReadinessSummaryOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opGetResourceSet = "GetResourceSet"
+
+// GetResourceSetRequest generates a "aws/request.Request" representing the
+// client's request for the GetResourceSet operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See GetResourceSet for more information on using the GetResourceSet
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the GetResourceSetRequest method.
+// req, resp := client.GetResourceSetRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetResourceSet
+func (c *Route53RecoveryReadiness) GetResourceSetRequest(input *GetResourceSetInput) (req *request.Request, output *GetResourceSetOutput) {
+ op := &request.Operation{
+ Name: opGetResourceSet,
+ HTTPMethod: "GET",
+ HTTPPath: "/resourcesets/{resourceSetName}",
+ }
+
+ if input == nil {
+ input = &GetResourceSetInput{}
+ }
+
+ output = &GetResourceSetOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// GetResourceSet API operation for AWS Route53 Recovery Readiness.
+//
+// Returns information about a Resource Set.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation GetResourceSet for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/GetResourceSet
+func (c *Route53RecoveryReadiness) GetResourceSet(input *GetResourceSetInput) (*GetResourceSetOutput, error) {
+ req, out := c.GetResourceSetRequest(input)
+ return out, req.Send()
+}
+
+// GetResourceSetWithContext is the same as GetResourceSet with the addition of
+// the ability to pass a context and additional request options.
+//
+// See GetResourceSet for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) GetResourceSetWithContext(ctx aws.Context, input *GetResourceSetInput, opts ...request.Option) (*GetResourceSetOutput, error) {
+ req, out := c.GetResourceSetRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opListCells = "ListCells"
+
+// ListCellsRequest generates a "aws/request.Request" representing the
+// client's request for the ListCells operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListCells for more information on using the ListCells
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListCellsRequest method.
+// req, resp := client.ListCellsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListCells
+func (c *Route53RecoveryReadiness) ListCellsRequest(input *ListCellsInput) (req *request.Request, output *ListCellsOutput) {
+ op := &request.Operation{
+ Name: opListCells,
+ HTTPMethod: "GET",
+ HTTPPath: "/cells",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListCellsInput{}
+ }
+
+ output = &ListCellsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListCells API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of Cells.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListCells for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListCells
+func (c *Route53RecoveryReadiness) ListCells(input *ListCellsInput) (*ListCellsOutput, error) {
+ req, out := c.ListCellsRequest(input)
+ return out, req.Send()
+}
+
+// ListCellsWithContext is the same as ListCells with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListCells for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListCellsWithContext(ctx aws.Context, input *ListCellsInput, opts ...request.Option) (*ListCellsOutput, error) {
+ req, out := c.ListCellsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListCellsPages iterates over the pages of a ListCells operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListCells method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListCells operation.
+// pageNum := 0
+// err := client.ListCellsPages(params,
+// func(page *route53recoveryreadiness.ListCellsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListCellsPages(input *ListCellsInput, fn func(*ListCellsOutput, bool) bool) error {
+ return c.ListCellsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListCellsPagesWithContext same as ListCellsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListCellsPagesWithContext(ctx aws.Context, input *ListCellsInput, fn func(*ListCellsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListCellsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListCellsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListCellsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListCrossAccountAuthorizations = "ListCrossAccountAuthorizations"
+
+// ListCrossAccountAuthorizationsRequest generates a "aws/request.Request" representing the
+// client's request for the ListCrossAccountAuthorizations operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListCrossAccountAuthorizations for more information on using the ListCrossAccountAuthorizations
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListCrossAccountAuthorizationsRequest method.
+// req, resp := client.ListCrossAccountAuthorizationsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListCrossAccountAuthorizations
+func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizationsRequest(input *ListCrossAccountAuthorizationsInput) (req *request.Request, output *ListCrossAccountAuthorizationsOutput) {
+ op := &request.Operation{
+ Name: opListCrossAccountAuthorizations,
+ HTTPMethod: "GET",
+ HTTPPath: "/crossaccountauthorizations",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListCrossAccountAuthorizationsInput{}
+ }
+
+ output = &ListCrossAccountAuthorizationsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListCrossAccountAuthorizations API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of cross account readiness authorizations.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListCrossAccountAuthorizations for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListCrossAccountAuthorizations
+func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizations(input *ListCrossAccountAuthorizationsInput) (*ListCrossAccountAuthorizationsOutput, error) {
+ req, out := c.ListCrossAccountAuthorizationsRequest(input)
+ return out, req.Send()
+}
+
+// ListCrossAccountAuthorizationsWithContext is the same as ListCrossAccountAuthorizations with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListCrossAccountAuthorizations for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizationsWithContext(ctx aws.Context, input *ListCrossAccountAuthorizationsInput, opts ...request.Option) (*ListCrossAccountAuthorizationsOutput, error) {
+ req, out := c.ListCrossAccountAuthorizationsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListCrossAccountAuthorizationsPages iterates over the pages of a ListCrossAccountAuthorizations operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListCrossAccountAuthorizations method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListCrossAccountAuthorizations operation.
+// pageNum := 0
+// err := client.ListCrossAccountAuthorizationsPages(params,
+// func(page *route53recoveryreadiness.ListCrossAccountAuthorizationsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizationsPages(input *ListCrossAccountAuthorizationsInput, fn func(*ListCrossAccountAuthorizationsOutput, bool) bool) error {
+ return c.ListCrossAccountAuthorizationsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListCrossAccountAuthorizationsPagesWithContext same as ListCrossAccountAuthorizationsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListCrossAccountAuthorizationsPagesWithContext(ctx aws.Context, input *ListCrossAccountAuthorizationsInput, fn func(*ListCrossAccountAuthorizationsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListCrossAccountAuthorizationsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListCrossAccountAuthorizationsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListCrossAccountAuthorizationsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListReadinessChecks = "ListReadinessChecks"
+
+// ListReadinessChecksRequest generates a "aws/request.Request" representing the
+// client's request for the ListReadinessChecks operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListReadinessChecks for more information on using the ListReadinessChecks
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListReadinessChecksRequest method.
+// req, resp := client.ListReadinessChecksRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListReadinessChecks
+func (c *Route53RecoveryReadiness) ListReadinessChecksRequest(input *ListReadinessChecksInput) (req *request.Request, output *ListReadinessChecksOutput) {
+ op := &request.Operation{
+ Name: opListReadinessChecks,
+ HTTPMethod: "GET",
+ HTTPPath: "/readinesschecks",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListReadinessChecksInput{}
+ }
+
+ output = &ListReadinessChecksOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListReadinessChecks API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of Readiness Checks.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListReadinessChecks for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListReadinessChecks
+func (c *Route53RecoveryReadiness) ListReadinessChecks(input *ListReadinessChecksInput) (*ListReadinessChecksOutput, error) {
+ req, out := c.ListReadinessChecksRequest(input)
+ return out, req.Send()
+}
+
+// ListReadinessChecksWithContext is the same as ListReadinessChecks with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListReadinessChecks for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListReadinessChecksWithContext(ctx aws.Context, input *ListReadinessChecksInput, opts ...request.Option) (*ListReadinessChecksOutput, error) {
+ req, out := c.ListReadinessChecksRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListReadinessChecksPages iterates over the pages of a ListReadinessChecks operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListReadinessChecks method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListReadinessChecks operation.
+// pageNum := 0
+// err := client.ListReadinessChecksPages(params,
+// func(page *route53recoveryreadiness.ListReadinessChecksOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListReadinessChecksPages(input *ListReadinessChecksInput, fn func(*ListReadinessChecksOutput, bool) bool) error {
+ return c.ListReadinessChecksPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListReadinessChecksPagesWithContext same as ListReadinessChecksPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListReadinessChecksPagesWithContext(ctx aws.Context, input *ListReadinessChecksInput, fn func(*ListReadinessChecksOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListReadinessChecksInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListReadinessChecksRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListReadinessChecksOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListRecoveryGroups = "ListRecoveryGroups"
+
+// ListRecoveryGroupsRequest generates a "aws/request.Request" representing the
+// client's request for the ListRecoveryGroups operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListRecoveryGroups for more information on using the ListRecoveryGroups
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListRecoveryGroupsRequest method.
+// req, resp := client.ListRecoveryGroupsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListRecoveryGroups
+func (c *Route53RecoveryReadiness) ListRecoveryGroupsRequest(input *ListRecoveryGroupsInput) (req *request.Request, output *ListRecoveryGroupsOutput) {
+ op := &request.Operation{
+ Name: opListRecoveryGroups,
+ HTTPMethod: "GET",
+ HTTPPath: "/recoverygroups",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListRecoveryGroupsInput{}
+ }
+
+ output = &ListRecoveryGroupsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListRecoveryGroups API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of Recovery Groups.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListRecoveryGroups for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListRecoveryGroups
+func (c *Route53RecoveryReadiness) ListRecoveryGroups(input *ListRecoveryGroupsInput) (*ListRecoveryGroupsOutput, error) {
+ req, out := c.ListRecoveryGroupsRequest(input)
+ return out, req.Send()
+}
+
+// ListRecoveryGroupsWithContext is the same as ListRecoveryGroups with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListRecoveryGroups for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListRecoveryGroupsWithContext(ctx aws.Context, input *ListRecoveryGroupsInput, opts ...request.Option) (*ListRecoveryGroupsOutput, error) {
+ req, out := c.ListRecoveryGroupsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListRecoveryGroupsPages iterates over the pages of a ListRecoveryGroups operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListRecoveryGroups method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListRecoveryGroups operation.
+// pageNum := 0
+// err := client.ListRecoveryGroupsPages(params,
+// func(page *route53recoveryreadiness.ListRecoveryGroupsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListRecoveryGroupsPages(input *ListRecoveryGroupsInput, fn func(*ListRecoveryGroupsOutput, bool) bool) error {
+ return c.ListRecoveryGroupsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListRecoveryGroupsPagesWithContext same as ListRecoveryGroupsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListRecoveryGroupsPagesWithContext(ctx aws.Context, input *ListRecoveryGroupsInput, fn func(*ListRecoveryGroupsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListRecoveryGroupsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListRecoveryGroupsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListRecoveryGroupsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListResourceSets = "ListResourceSets"
+
+// ListResourceSetsRequest generates a "aws/request.Request" representing the
+// client's request for the ListResourceSets operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListResourceSets for more information on using the ListResourceSets
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListResourceSetsRequest method.
+// req, resp := client.ListResourceSetsRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListResourceSets
+func (c *Route53RecoveryReadiness) ListResourceSetsRequest(input *ListResourceSetsInput) (req *request.Request, output *ListResourceSetsOutput) {
+ op := &request.Operation{
+ Name: opListResourceSets,
+ HTTPMethod: "GET",
+ HTTPPath: "/resourcesets",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListResourceSetsInput{}
+ }
+
+ output = &ListResourceSetsOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListResourceSets API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of Resource Sets.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListResourceSets for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListResourceSets
+func (c *Route53RecoveryReadiness) ListResourceSets(input *ListResourceSetsInput) (*ListResourceSetsOutput, error) {
+ req, out := c.ListResourceSetsRequest(input)
+ return out, req.Send()
+}
+
+// ListResourceSetsWithContext is the same as ListResourceSets with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListResourceSets for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListResourceSetsWithContext(ctx aws.Context, input *ListResourceSetsInput, opts ...request.Option) (*ListResourceSetsOutput, error) {
+ req, out := c.ListResourceSetsRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListResourceSetsPages iterates over the pages of a ListResourceSets operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListResourceSets method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListResourceSets operation.
+// pageNum := 0
+// err := client.ListResourceSetsPages(params,
+// func(page *route53recoveryreadiness.ListResourceSetsOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListResourceSetsPages(input *ListResourceSetsInput, fn func(*ListResourceSetsOutput, bool) bool) error {
+ return c.ListResourceSetsPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListResourceSetsPagesWithContext same as ListResourceSetsPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListResourceSetsPagesWithContext(ctx aws.Context, input *ListResourceSetsInput, fn func(*ListResourceSetsOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListResourceSetsInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListResourceSetsRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListResourceSetsOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListRules = "ListRules"
+
+// ListRulesRequest generates a "aws/request.Request" representing the
+// client's request for the ListRules operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListRules for more information on using the ListRules
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListRulesRequest method.
+// req, resp := client.ListRulesRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListRules
+func (c *Route53RecoveryReadiness) ListRulesRequest(input *ListRulesInput) (req *request.Request, output *ListRulesOutput) {
+ op := &request.Operation{
+ Name: opListRules,
+ HTTPMethod: "GET",
+ HTTPPath: "/rules",
+ Paginator: &request.Paginator{
+ InputTokens: []string{"NextToken"},
+ OutputTokens: []string{"NextToken"},
+ LimitToken: "MaxResults",
+ TruncationToken: "",
+ },
+ }
+
+ if input == nil {
+ input = &ListRulesInput{}
+ }
+
+ output = &ListRulesOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListRules API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a collection of rules that are applied as part of Readiness Checks.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListRules for usage and error information.
+//
+// Returned Error Types:
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListRules
+func (c *Route53RecoveryReadiness) ListRules(input *ListRulesInput) (*ListRulesOutput, error) {
+ req, out := c.ListRulesRequest(input)
+ return out, req.Send()
+}
+
+// ListRulesWithContext is the same as ListRules with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListRules for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListRulesWithContext(ctx aws.Context, input *ListRulesInput, opts ...request.Option) (*ListRulesOutput, error) {
+ req, out := c.ListRulesRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+// ListRulesPages iterates over the pages of a ListRules operation,
+// calling the "fn" function with the response data for each page. To stop
+// iterating, return false from the fn function.
+//
+// See ListRules method for more information on how to use this operation.
+//
+// Note: This operation can generate multiple requests to a service.
+//
+// // Example iterating over at most 3 pages of a ListRules operation.
+// pageNum := 0
+// err := client.ListRulesPages(params,
+// func(page *route53recoveryreadiness.ListRulesOutput, lastPage bool) bool {
+// pageNum++
+// fmt.Println(page)
+// return pageNum <= 3
+// })
+//
+func (c *Route53RecoveryReadiness) ListRulesPages(input *ListRulesInput, fn func(*ListRulesOutput, bool) bool) error {
+ return c.ListRulesPagesWithContext(aws.BackgroundContext(), input, fn)
+}
+
+// ListRulesPagesWithContext same as ListRulesPages except
+// it takes a Context and allows setting request options on the pages.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListRulesPagesWithContext(ctx aws.Context, input *ListRulesInput, fn func(*ListRulesOutput, bool) bool, opts ...request.Option) error {
+ p := request.Pagination{
+ NewRequest: func() (*request.Request, error) {
+ var inCpy *ListRulesInput
+ if input != nil {
+ tmp := *input
+ inCpy = &tmp
+ }
+ req, _ := c.ListRulesRequest(inCpy)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return req, nil
+ },
+ }
+
+ for p.Next() {
+ if !fn(p.Page().(*ListRulesOutput), !p.HasNextPage()) {
+ break
+ }
+ }
+
+ return p.Err()
+}
+
+const opListTagsForResources = "ListTagsForResources"
+
+// ListTagsForResourcesRequest generates a "aws/request.Request" representing the
+// client's request for the ListTagsForResources operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See ListTagsForResources for more information on using the ListTagsForResources
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the ListTagsForResourcesRequest method.
+// req, resp := client.ListTagsForResourcesRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListTagsForResources
+func (c *Route53RecoveryReadiness) ListTagsForResourcesRequest(input *ListTagsForResourcesInput) (req *request.Request, output *ListTagsForResourcesOutput) {
+ op := &request.Operation{
+ Name: opListTagsForResources,
+ HTTPMethod: "GET",
+ HTTPPath: "/tags/{resource-arn}",
+ }
+
+ if input == nil {
+ input = &ListTagsForResourcesInput{}
+ }
+
+ output = &ListTagsForResourcesOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// ListTagsForResources API operation for AWS Route53 Recovery Readiness.
+//
+// Returns a list of the tags assigned to the specified resource.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation ListTagsForResources for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/ListTagsForResources
+func (c *Route53RecoveryReadiness) ListTagsForResources(input *ListTagsForResourcesInput) (*ListTagsForResourcesOutput, error) {
+ req, out := c.ListTagsForResourcesRequest(input)
+ return out, req.Send()
+}
+
+// ListTagsForResourcesWithContext is the same as ListTagsForResources with the addition of
+// the ability to pass a context and additional request options.
+//
+// See ListTagsForResources for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) ListTagsForResourcesWithContext(ctx aws.Context, input *ListTagsForResourcesInput, opts ...request.Option) (*ListTagsForResourcesOutput, error) {
+ req, out := c.ListTagsForResourcesRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opTagResource = "TagResource"
+
+// TagResourceRequest generates a "aws/request.Request" representing the
+// client's request for the TagResource operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See TagResource for more information on using the TagResource
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the TagResourceRequest method.
+// req, resp := client.TagResourceRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/TagResource
+func (c *Route53RecoveryReadiness) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) {
+ op := &request.Operation{
+ Name: opTagResource,
+ HTTPMethod: "POST",
+ HTTPPath: "/tags/{resource-arn}",
+ }
+
+ if input == nil {
+ input = &TagResourceInput{}
+ }
+
+ output = &TagResourceOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// TagResource API operation for AWS Route53 Recovery Readiness.
+//
+// Adds tags to the specified resource. You can specify one or more tags to
+// add.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation TagResource for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/TagResource
+func (c *Route53RecoveryReadiness) TagResource(input *TagResourceInput) (*TagResourceOutput, error) {
+ req, out := c.TagResourceRequest(input)
+ return out, req.Send()
+}
+
+// TagResourceWithContext is the same as TagResource with the addition of
+// the ability to pass a context and additional request options.
+//
+// See TagResource for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) {
+ req, out := c.TagResourceRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUntagResource = "UntagResource"
+
+// UntagResourceRequest generates a "aws/request.Request" representing the
+// client's request for the UntagResource operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UntagResource for more information on using the UntagResource
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UntagResourceRequest method.
+// req, resp := client.UntagResourceRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UntagResource
+func (c *Route53RecoveryReadiness) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) {
+ op := &request.Operation{
+ Name: opUntagResource,
+ HTTPMethod: "DELETE",
+ HTTPPath: "/tags/{resource-arn}",
+ }
+
+ if input == nil {
+ input = &UntagResourceInput{}
+ }
+
+ output = &UntagResourceOutput{}
+ req = c.newRequest(op, input, output)
+ req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
+ return
+}
+
+// UntagResource API operation for AWS Route53 Recovery Readiness.
+//
+// Removes tags from the specified resource. You can specify one or more tags
+// to remove.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation UntagResource for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UntagResource
+func (c *Route53RecoveryReadiness) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) {
+ req, out := c.UntagResourceRequest(input)
+ return out, req.Send()
+}
+
+// UntagResourceWithContext is the same as UntagResource with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UntagResource for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) {
+ req, out := c.UntagResourceRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateCell = "UpdateCell"
+
+// UpdateCellRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateCell operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateCell for more information on using the UpdateCell
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateCellRequest method.
+// req, resp := client.UpdateCellRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateCell
+func (c *Route53RecoveryReadiness) UpdateCellRequest(input *UpdateCellInput) (req *request.Request, output *UpdateCellOutput) {
+ op := &request.Operation{
+ Name: opUpdateCell,
+ HTTPMethod: "PUT",
+ HTTPPath: "/cells/{cellName}",
+ }
+
+ if input == nil {
+ input = &UpdateCellInput{}
+ }
+
+ output = &UpdateCellOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateCell API operation for AWS Route53 Recovery Readiness.
+//
+// Updates an existing Cell.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation UpdateCell for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateCell
+func (c *Route53RecoveryReadiness) UpdateCell(input *UpdateCellInput) (*UpdateCellOutput, error) {
+ req, out := c.UpdateCellRequest(input)
+ return out, req.Send()
+}
+
+// UpdateCellWithContext is the same as UpdateCell with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateCell for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) UpdateCellWithContext(ctx aws.Context, input *UpdateCellInput, opts ...request.Option) (*UpdateCellOutput, error) {
+ req, out := c.UpdateCellRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateReadinessCheck = "UpdateReadinessCheck"
+
+// UpdateReadinessCheckRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateReadinessCheck operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateReadinessCheck for more information on using the UpdateReadinessCheck
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateReadinessCheckRequest method.
+// req, resp := client.UpdateReadinessCheckRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateReadinessCheck
+func (c *Route53RecoveryReadiness) UpdateReadinessCheckRequest(input *UpdateReadinessCheckInput) (req *request.Request, output *UpdateReadinessCheckOutput) {
+ op := &request.Operation{
+ Name: opUpdateReadinessCheck,
+ HTTPMethod: "PUT",
+ HTTPPath: "/readinesschecks/{readinessCheckName}",
+ }
+
+ if input == nil {
+ input = &UpdateReadinessCheckInput{}
+ }
+
+ output = &UpdateReadinessCheckOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateReadinessCheck API operation for AWS Route53 Recovery Readiness.
+//
+// Updates an exisiting Readiness Check.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation UpdateReadinessCheck for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateReadinessCheck
+func (c *Route53RecoveryReadiness) UpdateReadinessCheck(input *UpdateReadinessCheckInput) (*UpdateReadinessCheckOutput, error) {
+ req, out := c.UpdateReadinessCheckRequest(input)
+ return out, req.Send()
+}
+
+// UpdateReadinessCheckWithContext is the same as UpdateReadinessCheck with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateReadinessCheck for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) UpdateReadinessCheckWithContext(ctx aws.Context, input *UpdateReadinessCheckInput, opts ...request.Option) (*UpdateReadinessCheckOutput, error) {
+ req, out := c.UpdateReadinessCheckRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateRecoveryGroup = "UpdateRecoveryGroup"
+
+// UpdateRecoveryGroupRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateRecoveryGroup operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateRecoveryGroup for more information on using the UpdateRecoveryGroup
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateRecoveryGroupRequest method.
+// req, resp := client.UpdateRecoveryGroupRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateRecoveryGroup
+func (c *Route53RecoveryReadiness) UpdateRecoveryGroupRequest(input *UpdateRecoveryGroupInput) (req *request.Request, output *UpdateRecoveryGroupOutput) {
+ op := &request.Operation{
+ Name: opUpdateRecoveryGroup,
+ HTTPMethod: "PUT",
+ HTTPPath: "/recoverygroups/{recoveryGroupName}",
+ }
+
+ if input == nil {
+ input = &UpdateRecoveryGroupInput{}
+ }
+
+ output = &UpdateRecoveryGroupOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateRecoveryGroup API operation for AWS Route53 Recovery Readiness.
+//
+// Updates an existing Recovery Group.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation UpdateRecoveryGroup for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateRecoveryGroup
+func (c *Route53RecoveryReadiness) UpdateRecoveryGroup(input *UpdateRecoveryGroupInput) (*UpdateRecoveryGroupOutput, error) {
+ req, out := c.UpdateRecoveryGroupRequest(input)
+ return out, req.Send()
+}
+
+// UpdateRecoveryGroupWithContext is the same as UpdateRecoveryGroup with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateRecoveryGroup for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) UpdateRecoveryGroupWithContext(ctx aws.Context, input *UpdateRecoveryGroupInput, opts ...request.Option) (*UpdateRecoveryGroupOutput, error) {
+ req, out := c.UpdateRecoveryGroupRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+const opUpdateResourceSet = "UpdateResourceSet"
+
+// UpdateResourceSetRequest generates a "aws/request.Request" representing the
+// client's request for the UpdateResourceSet operation. The "output" return
+// value will be populated with the request's response once the request completes
+// successfully.
+//
+// Use "Send" method on the returned Request to send the API call to the service.
+// the "output" return value is not valid until after Send returns without error.
+//
+// See UpdateResourceSet for more information on using the UpdateResourceSet
+// API call, and error handling.
+//
+// This method is useful when you want to inject custom logic or configuration
+// into the SDK's request lifecycle. Such as custom headers, or retry logic.
+//
+//
+// // Example sending a request using the UpdateResourceSetRequest method.
+// req, resp := client.UpdateResourceSetRequest(params)
+//
+// err := req.Send()
+// if err == nil { // resp is now filled
+// fmt.Println(resp)
+// }
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateResourceSet
+func (c *Route53RecoveryReadiness) UpdateResourceSetRequest(input *UpdateResourceSetInput) (req *request.Request, output *UpdateResourceSetOutput) {
+ op := &request.Operation{
+ Name: opUpdateResourceSet,
+ HTTPMethod: "PUT",
+ HTTPPath: "/resourcesets/{resourceSetName}",
+ }
+
+ if input == nil {
+ input = &UpdateResourceSetInput{}
+ }
+
+ output = &UpdateResourceSetOutput{}
+ req = c.newRequest(op, input, output)
+ return
+}
+
+// UpdateResourceSet API operation for AWS Route53 Recovery Readiness.
+//
+// Updates an existing Resource Set.
+//
+// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
+// with awserr.Error's Code and Message methods to get detailed information about
+// the error.
+//
+// See the AWS API reference guide for AWS Route53 Recovery Readiness's
+// API operation UpdateResourceSet for usage and error information.
+//
+// Returned Error Types:
+// * ResourceNotFoundException
+//
+// * ThrottlingException
+//
+// * ValidationException
+//
+// * InternalServerException
+//
+// * AccessDeniedException
+//
+// See also, https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02/UpdateResourceSet
+func (c *Route53RecoveryReadiness) UpdateResourceSet(input *UpdateResourceSetInput) (*UpdateResourceSetOutput, error) {
+ req, out := c.UpdateResourceSetRequest(input)
+ return out, req.Send()
+}
+
+// UpdateResourceSetWithContext is the same as UpdateResourceSet with the addition of
+// the ability to pass a context and additional request options.
+//
+// See UpdateResourceSet for details on how to use this API operation.
+//
+// The context must be non-nil and will be used for request cancellation. If
+// the context is nil a panic will occur. In the future the SDK may create
+// sub-contexts for http.Requests. See https://golang.org/pkg/context/
+// for more information on using Contexts.
+func (c *Route53RecoveryReadiness) UpdateResourceSetWithContext(ctx aws.Context, input *UpdateResourceSetInput, opts ...request.Option) (*UpdateResourceSetOutput, error) {
+ req, out := c.UpdateResourceSetRequest(input)
+ req.SetContext(ctx)
+ req.ApplyOptions(opts...)
+ return out, req.Send()
+}
+
+type AccessDeniedException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s AccessDeniedException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AccessDeniedException) GoString() string {
+ return s.String()
+}
+
+func newErrorAccessDeniedException(v protocol.ResponseMetadata) error {
+ return &AccessDeniedException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *AccessDeniedException) Code() string {
+ return "AccessDeniedException"
+}
+
+// Message returns the exception's message.
+func (s *AccessDeniedException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *AccessDeniedException) OrigErr() error {
+ return nil
+}
+
+func (s *AccessDeniedException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *AccessDeniedException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *AccessDeniedException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// A Cell and its properties
+type CellOutput_ struct {
+ _ struct{} `type:"structure"`
+
+ // The arn for the Cell
+ //
+ // CellArn is a required field
+ CellArn *string `locationName:"cellArn" type:"string" required:"true"`
+
+ // The name of the Cell
+ //
+ // CellName is a required field
+ CellName *string `locationName:"cellName" type:"string" required:"true"`
+
+ // A list of Cell arns
+ //
+ // Cells is a required field
+ Cells []*string `locationName:"cells" type:"list" required:"true"`
+
+ // A list of Cell ARNs and/or RecoveryGroup ARNs
+ //
+ // ParentReadinessScopes is a required field
+ ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CellOutput_) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CellOutput_) GoString() string {
+ return s.String()
+}
+
+// SetCellArn sets the CellArn field's value.
+func (s *CellOutput_) SetCellArn(v string) *CellOutput_ {
+ s.CellArn = &v
+ return s
+}
+
+// SetCellName sets the CellName field's value.
+func (s *CellOutput_) SetCellName(v string) *CellOutput_ {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *CellOutput_) SetCells(v []*string) *CellOutput_ {
+ s.Cells = v
+ return s
+}
+
+// SetParentReadinessScopes sets the ParentReadinessScopes field's value.
+func (s *CellOutput_) SetParentReadinessScopes(v []*string) *CellOutput_ {
+ s.ParentReadinessScopes = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CellOutput_) SetTags(v map[string]*string) *CellOutput_ {
+ s.Tags = v
+ return s
+}
+
+type ConflictException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ConflictException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ConflictException) GoString() string {
+ return s.String()
+}
+
+func newErrorConflictException(v protocol.ResponseMetadata) error {
+ return &ConflictException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ConflictException) Code() string {
+ return "ConflictException"
+}
+
+// Message returns the exception's message.
+func (s *ConflictException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ConflictException) OrigErr() error {
+ return nil
+}
+
+func (s *ConflictException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ConflictException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ConflictException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type CreateCellInput struct {
+ _ struct{} `type:"structure"`
+
+ // CellName is a required field
+ CellName *string `locationName:"cellName" type:"string" required:"true"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateCellInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateCellInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateCellInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateCellInput"}
+ if s.CellName == nil {
+ invalidParams.Add(request.NewErrParamRequired("CellName"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCellName sets the CellName field's value.
+func (s *CreateCellInput) SetCellName(v string) *CreateCellInput {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *CreateCellInput) SetCells(v []*string) *CreateCellInput {
+ s.Cells = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateCellInput) SetTags(v map[string]*string) *CreateCellInput {
+ s.Tags = v
+ return s
+}
+
+type CreateCellOutput struct {
+ _ struct{} `type:"structure"`
+
+ CellArn *string `locationName:"cellArn" type:"string"`
+
+ CellName *string `locationName:"cellName" type:"string"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateCellOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateCellOutput) GoString() string {
+ return s.String()
+}
+
+// SetCellArn sets the CellArn field's value.
+func (s *CreateCellOutput) SetCellArn(v string) *CreateCellOutput {
+ s.CellArn = &v
+ return s
+}
+
+// SetCellName sets the CellName field's value.
+func (s *CreateCellOutput) SetCellName(v string) *CreateCellOutput {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *CreateCellOutput) SetCells(v []*string) *CreateCellOutput {
+ s.Cells = v
+ return s
+}
+
+// SetParentReadinessScopes sets the ParentReadinessScopes field's value.
+func (s *CreateCellOutput) SetParentReadinessScopes(v []*string) *CreateCellOutput {
+ s.ParentReadinessScopes = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateCellOutput) SetTags(v map[string]*string) *CreateCellOutput {
+ s.Tags = v
+ return s
+}
+
+type CreateCrossAccountAuthorizationInput struct {
+ _ struct{} `type:"structure"`
+
+ // A cross-account authorization, e.g. arn:aws:iam::123456789012:root
+ //
+ // CrossAccountAuthorization is a required field
+ CrossAccountAuthorization *string `locationName:"crossAccountAuthorization" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s CreateCrossAccountAuthorizationInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateCrossAccountAuthorizationInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateCrossAccountAuthorizationInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateCrossAccountAuthorizationInput"}
+ if s.CrossAccountAuthorization == nil {
+ invalidParams.Add(request.NewErrParamRequired("CrossAccountAuthorization"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCrossAccountAuthorization sets the CrossAccountAuthorization field's value.
+func (s *CreateCrossAccountAuthorizationInput) SetCrossAccountAuthorization(v string) *CreateCrossAccountAuthorizationInput {
+ s.CrossAccountAuthorization = &v
+ return s
+}
+
+type CreateCrossAccountAuthorizationOutput struct {
+ _ struct{} `type:"structure"`
+
+ // A cross-account authorization, e.g. arn:aws:iam::123456789012:root
+ CrossAccountAuthorization *string `locationName:"crossAccountAuthorization" type:"string"`
+}
+
+// String returns the string representation
+func (s CreateCrossAccountAuthorizationOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateCrossAccountAuthorizationOutput) GoString() string {
+ return s.String()
+}
+
+// SetCrossAccountAuthorization sets the CrossAccountAuthorization field's value.
+func (s *CreateCrossAccountAuthorizationOutput) SetCrossAccountAuthorization(v string) *CreateCrossAccountAuthorizationOutput {
+ s.CrossAccountAuthorization = &v
+ return s
+}
+
+type CreateReadinessCheckInput struct {
+ _ struct{} `type:"structure"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string" required:"true"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateReadinessCheckInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateReadinessCheckInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateReadinessCheckInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateReadinessCheckInput"}
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *CreateReadinessCheckInput) SetReadinessCheckName(v string) *CreateReadinessCheckInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *CreateReadinessCheckInput) SetResourceSetName(v string) *CreateReadinessCheckInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateReadinessCheckInput) SetTags(v map[string]*string) *CreateReadinessCheckInput {
+ s.Tags = v
+ return s
+}
+
+type CreateReadinessCheckOutput struct {
+ _ struct{} `type:"structure"`
+
+ ReadinessCheckArn *string `locationName:"readinessCheckArn" type:"string"`
+
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"`
+
+ ResourceSet *string `locationName:"resourceSet" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateReadinessCheckOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateReadinessCheckOutput) GoString() string {
+ return s.String()
+}
+
+// SetReadinessCheckArn sets the ReadinessCheckArn field's value.
+func (s *CreateReadinessCheckOutput) SetReadinessCheckArn(v string) *CreateReadinessCheckOutput {
+ s.ReadinessCheckArn = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *CreateReadinessCheckOutput) SetReadinessCheckName(v string) *CreateReadinessCheckOutput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSet sets the ResourceSet field's value.
+func (s *CreateReadinessCheckOutput) SetResourceSet(v string) *CreateReadinessCheckOutput {
+ s.ResourceSet = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateReadinessCheckOutput) SetTags(v map[string]*string) *CreateReadinessCheckOutput {
+ s.Tags = v
+ return s
+}
+
+type CreateRecoveryGroupInput struct {
+ _ struct{} `type:"structure"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateRecoveryGroupInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateRecoveryGroupInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateRecoveryGroupInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateRecoveryGroupInput"}
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCells sets the Cells field's value.
+func (s *CreateRecoveryGroupInput) SetCells(v []*string) *CreateRecoveryGroupInput {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *CreateRecoveryGroupInput) SetRecoveryGroupName(v string) *CreateRecoveryGroupInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateRecoveryGroupInput) SetTags(v map[string]*string) *CreateRecoveryGroupInput {
+ s.Tags = v
+ return s
+}
+
+type CreateRecoveryGroupOutput struct {
+ _ struct{} `type:"structure"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ RecoveryGroupArn *string `locationName:"recoveryGroupArn" type:"string"`
+
+ RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateRecoveryGroupOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateRecoveryGroupOutput) GoString() string {
+ return s.String()
+}
+
+// SetCells sets the Cells field's value.
+func (s *CreateRecoveryGroupOutput) SetCells(v []*string) *CreateRecoveryGroupOutput {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupArn sets the RecoveryGroupArn field's value.
+func (s *CreateRecoveryGroupOutput) SetRecoveryGroupArn(v string) *CreateRecoveryGroupOutput {
+ s.RecoveryGroupArn = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *CreateRecoveryGroupOutput) SetRecoveryGroupName(v string) *CreateRecoveryGroupOutput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateRecoveryGroupOutput) SetTags(v map[string]*string) *CreateRecoveryGroupOutput {
+ s.Tags = v
+ return s
+}
+
+type CreateResourceSetInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"`
+
+ // ResourceSetType is a required field
+ ResourceSetType *string `locationName:"resourceSetType" type:"string" required:"true"`
+
+ // Resources is a required field
+ Resources []*Resource `locationName:"resources" type:"list" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateResourceSetInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateResourceSetInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *CreateResourceSetInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "CreateResourceSetInput"}
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+ if s.ResourceSetType == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetType"))
+ }
+ if s.Resources == nil {
+ invalidParams.Add(request.NewErrParamRequired("Resources"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *CreateResourceSetInput) SetResourceSetName(v string) *CreateResourceSetInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *CreateResourceSetInput) SetResourceSetType(v string) *CreateResourceSetInput {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *CreateResourceSetInput) SetResources(v []*Resource) *CreateResourceSetInput {
+ s.Resources = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateResourceSetInput) SetTags(v map[string]*string) *CreateResourceSetInput {
+ s.Tags = v
+ return s
+}
+
+type CreateResourceSetOutput struct {
+ _ struct{} `type:"structure"`
+
+ ResourceSetArn *string `locationName:"resourceSetArn" type:"string"`
+
+ ResourceSetName *string `locationName:"resourceSetName" type:"string"`
+
+ ResourceSetType *string `locationName:"resourceSetType" type:"string"`
+
+ Resources []*Resource `locationName:"resources" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s CreateResourceSetOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s CreateResourceSetOutput) GoString() string {
+ return s.String()
+}
+
+// SetResourceSetArn sets the ResourceSetArn field's value.
+func (s *CreateResourceSetOutput) SetResourceSetArn(v string) *CreateResourceSetOutput {
+ s.ResourceSetArn = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *CreateResourceSetOutput) SetResourceSetName(v string) *CreateResourceSetOutput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *CreateResourceSetOutput) SetResourceSetType(v string) *CreateResourceSetOutput {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *CreateResourceSetOutput) SetResources(v []*Resource) *CreateResourceSetOutput {
+ s.Resources = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *CreateResourceSetOutput) SetTags(v map[string]*string) *CreateResourceSetOutput {
+ s.Tags = v
+ return s
+}
+
+// A component for DNS/Routing Control Readiness Checks
+type DNSTargetResource struct {
+ _ struct{} `type:"structure"`
+
+ // The DNS Name that acts as ingress point to a portion of application
+ DomainName *string `locationName:"domainName" type:"string"`
+
+ // The Hosted Zone ARN that contains the DNS record with the provided name of
+ // target resource.
+ HostedZoneArn *string `locationName:"hostedZoneArn" type:"string"`
+
+ // The R53 Set Id to uniquely identify a record given a Name and a Type
+ RecordSetId *string `locationName:"recordSetId" type:"string"`
+
+ // The Type of DNS Record of target resource
+ RecordType *string `locationName:"recordType" type:"string"`
+
+ // The target resource the R53 record points to
+ TargetResource *TargetResource `locationName:"targetResource" type:"structure"`
+}
+
+// String returns the string representation
+func (s DNSTargetResource) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DNSTargetResource) GoString() string {
+ return s.String()
+}
+
+// SetDomainName sets the DomainName field's value.
+func (s *DNSTargetResource) SetDomainName(v string) *DNSTargetResource {
+ s.DomainName = &v
+ return s
+}
+
+// SetHostedZoneArn sets the HostedZoneArn field's value.
+func (s *DNSTargetResource) SetHostedZoneArn(v string) *DNSTargetResource {
+ s.HostedZoneArn = &v
+ return s
+}
+
+// SetRecordSetId sets the RecordSetId field's value.
+func (s *DNSTargetResource) SetRecordSetId(v string) *DNSTargetResource {
+ s.RecordSetId = &v
+ return s
+}
+
+// SetRecordType sets the RecordType field's value.
+func (s *DNSTargetResource) SetRecordType(v string) *DNSTargetResource {
+ s.RecordType = &v
+ return s
+}
+
+// SetTargetResource sets the TargetResource field's value.
+func (s *DNSTargetResource) SetTargetResource(v *TargetResource) *DNSTargetResource {
+ s.TargetResource = v
+ return s
+}
+
+type DeleteCellInput struct {
+ _ struct{} `type:"structure"`
+
+ // CellName is a required field
+ CellName *string `location:"uri" locationName:"cellName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteCellInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteCellInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteCellInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteCellInput"}
+ if s.CellName == nil {
+ invalidParams.Add(request.NewErrParamRequired("CellName"))
+ }
+ if s.CellName != nil && len(*s.CellName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("CellName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCellName sets the CellName field's value.
+func (s *DeleteCellInput) SetCellName(v string) *DeleteCellInput {
+ s.CellName = &v
+ return s
+}
+
+type DeleteCellOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteCellOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteCellOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteCrossAccountAuthorizationInput struct {
+ _ struct{} `type:"structure"`
+
+ // CrossAccountAuthorization is a required field
+ CrossAccountAuthorization *string `location:"uri" locationName:"crossAccountAuthorization" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteCrossAccountAuthorizationInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteCrossAccountAuthorizationInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteCrossAccountAuthorizationInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteCrossAccountAuthorizationInput"}
+ if s.CrossAccountAuthorization == nil {
+ invalidParams.Add(request.NewErrParamRequired("CrossAccountAuthorization"))
+ }
+ if s.CrossAccountAuthorization != nil && len(*s.CrossAccountAuthorization) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("CrossAccountAuthorization", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCrossAccountAuthorization sets the CrossAccountAuthorization field's value.
+func (s *DeleteCrossAccountAuthorizationInput) SetCrossAccountAuthorization(v string) *DeleteCrossAccountAuthorizationInput {
+ s.CrossAccountAuthorization = &v
+ return s
+}
+
+type DeleteCrossAccountAuthorizationOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteCrossAccountAuthorizationOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteCrossAccountAuthorizationOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteReadinessCheckInput struct {
+ _ struct{} `type:"structure"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `location:"uri" locationName:"readinessCheckName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteReadinessCheckInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteReadinessCheckInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteReadinessCheckInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteReadinessCheckInput"}
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ReadinessCheckName != nil && len(*s.ReadinessCheckName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ReadinessCheckName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *DeleteReadinessCheckInput) SetReadinessCheckName(v string) *DeleteReadinessCheckInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+type DeleteReadinessCheckOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteReadinessCheckOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteReadinessCheckOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteRecoveryGroupInput struct {
+ _ struct{} `type:"structure"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `location:"uri" locationName:"recoveryGroupName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteRecoveryGroupInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteRecoveryGroupInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteRecoveryGroupInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteRecoveryGroupInput"}
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+ if s.RecoveryGroupName != nil && len(*s.RecoveryGroupName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RecoveryGroupName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *DeleteRecoveryGroupInput) SetRecoveryGroupName(v string) *DeleteRecoveryGroupInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+type DeleteRecoveryGroupOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteRecoveryGroupOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteRecoveryGroupOutput) GoString() string {
+ return s.String()
+}
+
+type DeleteResourceSetInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `location:"uri" locationName:"resourceSetName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s DeleteResourceSetInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteResourceSetInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *DeleteResourceSetInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "DeleteResourceSetInput"}
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+ if s.ResourceSetName != nil && len(*s.ResourceSetName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceSetName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *DeleteResourceSetInput) SetResourceSetName(v string) *DeleteResourceSetInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+type DeleteResourceSetOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s DeleteResourceSetOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s DeleteResourceSetOutput) GoString() string {
+ return s.String()
+}
+
+type GetArchitectureRecommendationsInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `location:"uri" locationName:"recoveryGroupName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetArchitectureRecommendationsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetArchitectureRecommendationsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetArchitectureRecommendationsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetArchitectureRecommendationsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+ if s.RecoveryGroupName != nil && len(*s.RecoveryGroupName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RecoveryGroupName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *GetArchitectureRecommendationsInput) SetMaxResults(v int64) *GetArchitectureRecommendationsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetArchitectureRecommendationsInput) SetNextToken(v string) *GetArchitectureRecommendationsInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *GetArchitectureRecommendationsInput) SetRecoveryGroupName(v string) *GetArchitectureRecommendationsInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+type GetArchitectureRecommendationsOutput struct {
+ _ struct{} `type:"structure"`
+
+ // The time a Recovery Group was last assessed for recommendations in UTC ISO-8601
+ // format
+ LastAuditTimestamp *time.Time `locationName:"lastAuditTimestamp" type:"timestamp" timestampFormat:"iso8601"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ Recommendations []*Recommendation `locationName:"recommendations" type:"list"`
+}
+
+// String returns the string representation
+func (s GetArchitectureRecommendationsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetArchitectureRecommendationsOutput) GoString() string {
+ return s.String()
+}
+
+// SetLastAuditTimestamp sets the LastAuditTimestamp field's value.
+func (s *GetArchitectureRecommendationsOutput) SetLastAuditTimestamp(v time.Time) *GetArchitectureRecommendationsOutput {
+ s.LastAuditTimestamp = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetArchitectureRecommendationsOutput) SetNextToken(v string) *GetArchitectureRecommendationsOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRecommendations sets the Recommendations field's value.
+func (s *GetArchitectureRecommendationsOutput) SetRecommendations(v []*Recommendation) *GetArchitectureRecommendationsOutput {
+ s.Recommendations = v
+ return s
+}
+
+type GetCellInput struct {
+ _ struct{} `type:"structure"`
+
+ // CellName is a required field
+ CellName *string `location:"uri" locationName:"cellName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetCellInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetCellInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetCellInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetCellInput"}
+ if s.CellName == nil {
+ invalidParams.Add(request.NewErrParamRequired("CellName"))
+ }
+ if s.CellName != nil && len(*s.CellName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("CellName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCellName sets the CellName field's value.
+func (s *GetCellInput) SetCellName(v string) *GetCellInput {
+ s.CellName = &v
+ return s
+}
+
+type GetCellOutput struct {
+ _ struct{} `type:"structure"`
+
+ CellArn *string `locationName:"cellArn" type:"string"`
+
+ CellName *string `locationName:"cellName" type:"string"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s GetCellOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetCellOutput) GoString() string {
+ return s.String()
+}
+
+// SetCellArn sets the CellArn field's value.
+func (s *GetCellOutput) SetCellArn(v string) *GetCellOutput {
+ s.CellArn = &v
+ return s
+}
+
+// SetCellName sets the CellName field's value.
+func (s *GetCellOutput) SetCellName(v string) *GetCellOutput {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *GetCellOutput) SetCells(v []*string) *GetCellOutput {
+ s.Cells = v
+ return s
+}
+
+// SetParentReadinessScopes sets the ParentReadinessScopes field's value.
+func (s *GetCellOutput) SetParentReadinessScopes(v []*string) *GetCellOutput {
+ s.ParentReadinessScopes = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *GetCellOutput) SetTags(v map[string]*string) *GetCellOutput {
+ s.Tags = v
+ return s
+}
+
+type GetCellReadinessSummaryInput struct {
+ _ struct{} `type:"structure"`
+
+ // CellName is a required field
+ CellName *string `location:"uri" locationName:"cellName" type:"string" required:"true"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s GetCellReadinessSummaryInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetCellReadinessSummaryInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetCellReadinessSummaryInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetCellReadinessSummaryInput"}
+ if s.CellName == nil {
+ invalidParams.Add(request.NewErrParamRequired("CellName"))
+ }
+ if s.CellName != nil && len(*s.CellName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("CellName", 1))
+ }
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCellName sets the CellName field's value.
+func (s *GetCellReadinessSummaryInput) SetCellName(v string) *GetCellReadinessSummaryInput {
+ s.CellName = &v
+ return s
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *GetCellReadinessSummaryInput) SetMaxResults(v int64) *GetCellReadinessSummaryInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetCellReadinessSummaryInput) SetNextToken(v string) *GetCellReadinessSummaryInput {
+ s.NextToken = &v
+ return s
+}
+
+type GetCellReadinessSummaryOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ // The readiness of an entire ReadinessCheck or an individual resource ARN.
+ Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"`
+
+ ReadinessChecks []*ReadinessCheckSummary `locationName:"readinessChecks" type:"list"`
+}
+
+// String returns the string representation
+func (s GetCellReadinessSummaryOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetCellReadinessSummaryOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetCellReadinessSummaryOutput) SetNextToken(v string) *GetCellReadinessSummaryOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *GetCellReadinessSummaryOutput) SetReadiness(v string) *GetCellReadinessSummaryOutput {
+ s.Readiness = &v
+ return s
+}
+
+// SetReadinessChecks sets the ReadinessChecks field's value.
+func (s *GetCellReadinessSummaryOutput) SetReadinessChecks(v []*ReadinessCheckSummary) *GetCellReadinessSummaryOutput {
+ s.ReadinessChecks = v
+ return s
+}
+
+type GetReadinessCheckInput struct {
+ _ struct{} `type:"structure"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `location:"uri" locationName:"readinessCheckName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetReadinessCheckInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetReadinessCheckInput"}
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ReadinessCheckName != nil && len(*s.ReadinessCheckName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ReadinessCheckName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *GetReadinessCheckInput) SetReadinessCheckName(v string) *GetReadinessCheckInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+type GetReadinessCheckOutput struct {
+ _ struct{} `type:"structure"`
+
+ ReadinessCheckArn *string `locationName:"readinessCheckArn" type:"string"`
+
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"`
+
+ ResourceSet *string `locationName:"resourceSet" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckOutput) GoString() string {
+ return s.String()
+}
+
+// SetReadinessCheckArn sets the ReadinessCheckArn field's value.
+func (s *GetReadinessCheckOutput) SetReadinessCheckArn(v string) *GetReadinessCheckOutput {
+ s.ReadinessCheckArn = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *GetReadinessCheckOutput) SetReadinessCheckName(v string) *GetReadinessCheckOutput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSet sets the ResourceSet field's value.
+func (s *GetReadinessCheckOutput) SetResourceSet(v string) *GetReadinessCheckOutput {
+ s.ResourceSet = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *GetReadinessCheckOutput) SetTags(v map[string]*string) *GetReadinessCheckOutput {
+ s.Tags = v
+ return s
+}
+
+type GetReadinessCheckResourceStatusInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `location:"uri" locationName:"readinessCheckName" type:"string" required:"true"`
+
+ // ResourceIdentifier is a required field
+ ResourceIdentifier *string `location:"uri" locationName:"resourceIdentifier" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckResourceStatusInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckResourceStatusInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetReadinessCheckResourceStatusInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetReadinessCheckResourceStatusInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ReadinessCheckName != nil && len(*s.ReadinessCheckName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ReadinessCheckName", 1))
+ }
+ if s.ResourceIdentifier == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceIdentifier"))
+ }
+ if s.ResourceIdentifier != nil && len(*s.ResourceIdentifier) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceIdentifier", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *GetReadinessCheckResourceStatusInput) SetMaxResults(v int64) *GetReadinessCheckResourceStatusInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetReadinessCheckResourceStatusInput) SetNextToken(v string) *GetReadinessCheckResourceStatusInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *GetReadinessCheckResourceStatusInput) SetReadinessCheckName(v string) *GetReadinessCheckResourceStatusInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceIdentifier sets the ResourceIdentifier field's value.
+func (s *GetReadinessCheckResourceStatusInput) SetResourceIdentifier(v string) *GetReadinessCheckResourceStatusInput {
+ s.ResourceIdentifier = &v
+ return s
+}
+
+type GetReadinessCheckResourceStatusOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ // The readiness of an entire ReadinessCheck or an individual resource ARN.
+ Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"`
+
+ Rules []*RuleResult `locationName:"rules" type:"list"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckResourceStatusOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckResourceStatusOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetReadinessCheckResourceStatusOutput) SetNextToken(v string) *GetReadinessCheckResourceStatusOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *GetReadinessCheckResourceStatusOutput) SetReadiness(v string) *GetReadinessCheckResourceStatusOutput {
+ s.Readiness = &v
+ return s
+}
+
+// SetRules sets the Rules field's value.
+func (s *GetReadinessCheckResourceStatusOutput) SetRules(v []*RuleResult) *GetReadinessCheckResourceStatusOutput {
+ s.Rules = v
+ return s
+}
+
+type GetReadinessCheckStatusInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `location:"uri" locationName:"readinessCheckName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckStatusInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckStatusInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetReadinessCheckStatusInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetReadinessCheckStatusInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ReadinessCheckName != nil && len(*s.ReadinessCheckName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ReadinessCheckName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *GetReadinessCheckStatusInput) SetMaxResults(v int64) *GetReadinessCheckStatusInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetReadinessCheckStatusInput) SetNextToken(v string) *GetReadinessCheckStatusInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *GetReadinessCheckStatusInput) SetReadinessCheckName(v string) *GetReadinessCheckStatusInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+type GetReadinessCheckStatusOutput struct {
+ _ struct{} `type:"structure"`
+
+ Messages []*Message `locationName:"messages" type:"list"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ // The readiness of an entire ReadinessCheck or an individual resource ARN.
+ Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"`
+
+ Resources []*ResourceResult `locationName:"resources" type:"list"`
+}
+
+// String returns the string representation
+func (s GetReadinessCheckStatusOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetReadinessCheckStatusOutput) GoString() string {
+ return s.String()
+}
+
+// SetMessages sets the Messages field's value.
+func (s *GetReadinessCheckStatusOutput) SetMessages(v []*Message) *GetReadinessCheckStatusOutput {
+ s.Messages = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetReadinessCheckStatusOutput) SetNextToken(v string) *GetReadinessCheckStatusOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *GetReadinessCheckStatusOutput) SetReadiness(v string) *GetReadinessCheckStatusOutput {
+ s.Readiness = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *GetReadinessCheckStatusOutput) SetResources(v []*ResourceResult) *GetReadinessCheckStatusOutput {
+ s.Resources = v
+ return s
+}
+
+type GetRecoveryGroupInput struct {
+ _ struct{} `type:"structure"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `location:"uri" locationName:"recoveryGroupName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetRecoveryGroupInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRecoveryGroupInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetRecoveryGroupInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetRecoveryGroupInput"}
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+ if s.RecoveryGroupName != nil && len(*s.RecoveryGroupName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RecoveryGroupName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *GetRecoveryGroupInput) SetRecoveryGroupName(v string) *GetRecoveryGroupInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+type GetRecoveryGroupOutput struct {
+ _ struct{} `type:"structure"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ RecoveryGroupArn *string `locationName:"recoveryGroupArn" type:"string"`
+
+ RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s GetRecoveryGroupOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRecoveryGroupOutput) GoString() string {
+ return s.String()
+}
+
+// SetCells sets the Cells field's value.
+func (s *GetRecoveryGroupOutput) SetCells(v []*string) *GetRecoveryGroupOutput {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupArn sets the RecoveryGroupArn field's value.
+func (s *GetRecoveryGroupOutput) SetRecoveryGroupArn(v string) *GetRecoveryGroupOutput {
+ s.RecoveryGroupArn = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *GetRecoveryGroupOutput) SetRecoveryGroupName(v string) *GetRecoveryGroupOutput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *GetRecoveryGroupOutput) SetTags(v map[string]*string) *GetRecoveryGroupOutput {
+ s.Tags = v
+ return s
+}
+
+type GetRecoveryGroupReadinessSummaryInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `location:"uri" locationName:"recoveryGroupName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetRecoveryGroupReadinessSummaryInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRecoveryGroupReadinessSummaryInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetRecoveryGroupReadinessSummaryInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetRecoveryGroupReadinessSummaryInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+ if s.RecoveryGroupName != nil && len(*s.RecoveryGroupName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RecoveryGroupName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *GetRecoveryGroupReadinessSummaryInput) SetMaxResults(v int64) *GetRecoveryGroupReadinessSummaryInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetRecoveryGroupReadinessSummaryInput) SetNextToken(v string) *GetRecoveryGroupReadinessSummaryInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *GetRecoveryGroupReadinessSummaryInput) SetRecoveryGroupName(v string) *GetRecoveryGroupReadinessSummaryInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+type GetRecoveryGroupReadinessSummaryOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ // The readiness of an entire ReadinessCheck or an individual resource ARN.
+ Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"`
+
+ ReadinessChecks []*ReadinessCheckSummary `locationName:"readinessChecks" type:"list"`
+}
+
+// String returns the string representation
+func (s GetRecoveryGroupReadinessSummaryOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetRecoveryGroupReadinessSummaryOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *GetRecoveryGroupReadinessSummaryOutput) SetNextToken(v string) *GetRecoveryGroupReadinessSummaryOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *GetRecoveryGroupReadinessSummaryOutput) SetReadiness(v string) *GetRecoveryGroupReadinessSummaryOutput {
+ s.Readiness = &v
+ return s
+}
+
+// SetReadinessChecks sets the ReadinessChecks field's value.
+func (s *GetRecoveryGroupReadinessSummaryOutput) SetReadinessChecks(v []*ReadinessCheckSummary) *GetRecoveryGroupReadinessSummaryOutput {
+ s.ReadinessChecks = v
+ return s
+}
+
+type GetResourceSetInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `location:"uri" locationName:"resourceSetName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s GetResourceSetInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetResourceSetInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *GetResourceSetInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "GetResourceSetInput"}
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+ if s.ResourceSetName != nil && len(*s.ResourceSetName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceSetName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *GetResourceSetInput) SetResourceSetName(v string) *GetResourceSetInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+type GetResourceSetOutput struct {
+ _ struct{} `type:"structure"`
+
+ ResourceSetArn *string `locationName:"resourceSetArn" type:"string"`
+
+ ResourceSetName *string `locationName:"resourceSetName" type:"string"`
+
+ ResourceSetType *string `locationName:"resourceSetType" type:"string"`
+
+ Resources []*Resource `locationName:"resources" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s GetResourceSetOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s GetResourceSetOutput) GoString() string {
+ return s.String()
+}
+
+// SetResourceSetArn sets the ResourceSetArn field's value.
+func (s *GetResourceSetOutput) SetResourceSetArn(v string) *GetResourceSetOutput {
+ s.ResourceSetArn = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *GetResourceSetOutput) SetResourceSetName(v string) *GetResourceSetOutput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *GetResourceSetOutput) SetResourceSetType(v string) *GetResourceSetOutput {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *GetResourceSetOutput) SetResources(v []*Resource) *GetResourceSetOutput {
+ s.Resources = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *GetResourceSetOutput) SetTags(v map[string]*string) *GetResourceSetOutput {
+ s.Tags = v
+ return s
+}
+
+type InternalServerException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s InternalServerException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s InternalServerException) GoString() string {
+ return s.String()
+}
+
+func newErrorInternalServerException(v protocol.ResponseMetadata) error {
+ return &InternalServerException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *InternalServerException) Code() string {
+ return "InternalServerException"
+}
+
+// Message returns the exception's message.
+func (s *InternalServerException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *InternalServerException) OrigErr() error {
+ return nil
+}
+
+func (s *InternalServerException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *InternalServerException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *InternalServerException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type ListCellsInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListCellsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListCellsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListCellsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListCellsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListCellsInput) SetMaxResults(v int64) *ListCellsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListCellsInput) SetNextToken(v string) *ListCellsInput {
+ s.NextToken = &v
+ return s
+}
+
+type ListCellsOutput struct {
+ _ struct{} `type:"structure"`
+
+ Cells []*CellOutput_ `locationName:"cells" type:"list"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListCellsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListCellsOutput) GoString() string {
+ return s.String()
+}
+
+// SetCells sets the Cells field's value.
+func (s *ListCellsOutput) SetCells(v []*CellOutput_) *ListCellsOutput {
+ s.Cells = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListCellsOutput) SetNextToken(v string) *ListCellsOutput {
+ s.NextToken = &v
+ return s
+}
+
+type ListCrossAccountAuthorizationsInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListCrossAccountAuthorizationsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListCrossAccountAuthorizationsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListCrossAccountAuthorizationsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListCrossAccountAuthorizationsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListCrossAccountAuthorizationsInput) SetMaxResults(v int64) *ListCrossAccountAuthorizationsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListCrossAccountAuthorizationsInput) SetNextToken(v string) *ListCrossAccountAuthorizationsInput {
+ s.NextToken = &v
+ return s
+}
+
+type ListCrossAccountAuthorizationsOutput struct {
+ _ struct{} `type:"structure"`
+
+ CrossAccountAuthorizations []*string `locationName:"crossAccountAuthorizations" type:"list"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListCrossAccountAuthorizationsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListCrossAccountAuthorizationsOutput) GoString() string {
+ return s.String()
+}
+
+// SetCrossAccountAuthorizations sets the CrossAccountAuthorizations field's value.
+func (s *ListCrossAccountAuthorizationsOutput) SetCrossAccountAuthorizations(v []*string) *ListCrossAccountAuthorizationsOutput {
+ s.CrossAccountAuthorizations = v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListCrossAccountAuthorizationsOutput) SetNextToken(v string) *ListCrossAccountAuthorizationsOutput {
+ s.NextToken = &v
+ return s
+}
+
+type ListReadinessChecksInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListReadinessChecksInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListReadinessChecksInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListReadinessChecksInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListReadinessChecksInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListReadinessChecksInput) SetMaxResults(v int64) *ListReadinessChecksInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListReadinessChecksInput) SetNextToken(v string) *ListReadinessChecksInput {
+ s.NextToken = &v
+ return s
+}
+
+type ListReadinessChecksOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ ReadinessChecks []*ReadinessCheckOutput_ `locationName:"readinessChecks" type:"list"`
+}
+
+// String returns the string representation
+func (s ListReadinessChecksOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListReadinessChecksOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListReadinessChecksOutput) SetNextToken(v string) *ListReadinessChecksOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetReadinessChecks sets the ReadinessChecks field's value.
+func (s *ListReadinessChecksOutput) SetReadinessChecks(v []*ReadinessCheckOutput_) *ListReadinessChecksOutput {
+ s.ReadinessChecks = v
+ return s
+}
+
+type ListRecoveryGroupsInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListRecoveryGroupsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRecoveryGroupsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListRecoveryGroupsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListRecoveryGroupsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListRecoveryGroupsInput) SetMaxResults(v int64) *ListRecoveryGroupsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRecoveryGroupsInput) SetNextToken(v string) *ListRecoveryGroupsInput {
+ s.NextToken = &v
+ return s
+}
+
+type ListRecoveryGroupsOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ RecoveryGroups []*RecoveryGroupOutput_ `locationName:"recoveryGroups" type:"list"`
+}
+
+// String returns the string representation
+func (s ListRecoveryGroupsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRecoveryGroupsOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRecoveryGroupsOutput) SetNextToken(v string) *ListRecoveryGroupsOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRecoveryGroups sets the RecoveryGroups field's value.
+func (s *ListRecoveryGroupsOutput) SetRecoveryGroups(v []*RecoveryGroupOutput_) *ListRecoveryGroupsOutput {
+ s.RecoveryGroups = v
+ return s
+}
+
+type ListResourceSetsInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+}
+
+// String returns the string representation
+func (s ListResourceSetsInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListResourceSetsInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListResourceSetsInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListResourceSetsInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListResourceSetsInput) SetMaxResults(v int64) *ListResourceSetsInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListResourceSetsInput) SetNextToken(v string) *ListResourceSetsInput {
+ s.NextToken = &v
+ return s
+}
+
+type ListResourceSetsOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ ResourceSets []*ResourceSetOutput_ `locationName:"resourceSets" type:"list"`
+}
+
+// String returns the string representation
+func (s ListResourceSetsOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListResourceSetsOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListResourceSetsOutput) SetNextToken(v string) *ListResourceSetsOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetResourceSets sets the ResourceSets field's value.
+func (s *ListResourceSetsOutput) SetResourceSets(v []*ResourceSetOutput_) *ListResourceSetsOutput {
+ s.ResourceSets = v
+ return s
+}
+
+type ListRulesInput struct {
+ _ struct{} `type:"structure"`
+
+ MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
+
+ NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
+
+ ResourceType *string `location:"querystring" locationName:"resourceType" type:"string"`
+}
+
+// String returns the string representation
+func (s ListRulesInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRulesInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListRulesInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListRulesInput"}
+ if s.MaxResults != nil && *s.MaxResults < 1 {
+ invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetMaxResults sets the MaxResults field's value.
+func (s *ListRulesInput) SetMaxResults(v int64) *ListRulesInput {
+ s.MaxResults = &v
+ return s
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRulesInput) SetNextToken(v string) *ListRulesInput {
+ s.NextToken = &v
+ return s
+}
+
+// SetResourceType sets the ResourceType field's value.
+func (s *ListRulesInput) SetResourceType(v string) *ListRulesInput {
+ s.ResourceType = &v
+ return s
+}
+
+type ListRulesOutput struct {
+ _ struct{} `type:"structure"`
+
+ NextToken *string `locationName:"nextToken" type:"string"`
+
+ Rules []*ListRulesOutput_ `locationName:"rules" type:"list"`
+}
+
+// String returns the string representation
+func (s ListRulesOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRulesOutput) GoString() string {
+ return s.String()
+}
+
+// SetNextToken sets the NextToken field's value.
+func (s *ListRulesOutput) SetNextToken(v string) *ListRulesOutput {
+ s.NextToken = &v
+ return s
+}
+
+// SetRules sets the Rules field's value.
+func (s *ListRulesOutput) SetRules(v []*ListRulesOutput_) *ListRulesOutput {
+ s.Rules = v
+ return s
+}
+
+// A collection of rules used in a readiness check
+type ListRulesOutput_ struct {
+ _ struct{} `type:"structure"`
+
+ // The resource type the rule applies to.
+ //
+ // ResourceType is a required field
+ ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
+
+ // A description of the rule
+ //
+ // RuleDescription is a required field
+ RuleDescription *string `locationName:"ruleDescription" type:"string" required:"true"`
+
+ // The Rule's ID.
+ //
+ // RuleId is a required field
+ RuleId *string `locationName:"ruleId" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ListRulesOutput_) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListRulesOutput_) GoString() string {
+ return s.String()
+}
+
+// SetResourceType sets the ResourceType field's value.
+func (s *ListRulesOutput_) SetResourceType(v string) *ListRulesOutput_ {
+ s.ResourceType = &v
+ return s
+}
+
+// SetRuleDescription sets the RuleDescription field's value.
+func (s *ListRulesOutput_) SetRuleDescription(v string) *ListRulesOutput_ {
+ s.RuleDescription = &v
+ return s
+}
+
+// SetRuleId sets the RuleId field's value.
+func (s *ListRulesOutput_) SetRuleId(v string) *ListRulesOutput_ {
+ s.RuleId = &v
+ return s
+}
+
+type ListTagsForResourcesInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceArn is a required field
+ ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s ListTagsForResourcesInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListTagsForResourcesInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *ListTagsForResourcesInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourcesInput"}
+ if s.ResourceArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
+ }
+ if s.ResourceArn != nil && len(*s.ResourceArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceArn sets the ResourceArn field's value.
+func (s *ListTagsForResourcesInput) SetResourceArn(v string) *ListTagsForResourcesInput {
+ s.ResourceArn = &v
+ return s
+}
+
+type ListTagsForResourcesOutput struct {
+ _ struct{} `type:"structure"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s ListTagsForResourcesOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ListTagsForResourcesOutput) GoString() string {
+ return s.String()
+}
+
+// SetTags sets the Tags field's value.
+func (s *ListTagsForResourcesOutput) SetTags(v map[string]*string) *ListTagsForResourcesOutput {
+ s.Tags = v
+ return s
+}
+
+// Information relating to readiness check status
+type Message struct {
+ _ struct{} `type:"structure"`
+
+ // The text of a readiness check message
+ MessageText *string `locationName:"messageText" type:"string"`
+}
+
+// String returns the string representation
+func (s Message) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s Message) GoString() string {
+ return s.String()
+}
+
+// SetMessageText sets the MessageText field's value.
+func (s *Message) SetMessageText(v string) *Message {
+ s.MessageText = &v
+ return s
+}
+
+// The NLB resource a DNS Target Resource points to
+type NLBResource struct {
+ _ struct{} `type:"structure"`
+
+ // An NLB resource arn
+ Arn *string `locationName:"arn" type:"string"`
+}
+
+// String returns the string representation
+func (s NLBResource) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s NLBResource) GoString() string {
+ return s.String()
+}
+
+// SetArn sets the Arn field's value.
+func (s *NLBResource) SetArn(v string) *NLBResource {
+ s.Arn = &v
+ return s
+}
+
+// The Route 53 resource a DNS Target Resource record points to
+type R53ResourceRecord struct {
+ _ struct{} `type:"structure"`
+
+ // The DNS target name
+ DomainName *string `locationName:"domainName" type:"string"`
+
+ // The Resource Record set id
+ RecordSetId *string `locationName:"recordSetId" type:"string"`
+}
+
+// String returns the string representation
+func (s R53ResourceRecord) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s R53ResourceRecord) GoString() string {
+ return s.String()
+}
+
+// SetDomainName sets the DomainName field's value.
+func (s *R53ResourceRecord) SetDomainName(v string) *R53ResourceRecord {
+ s.DomainName = &v
+ return s
+}
+
+// SetRecordSetId sets the RecordSetId field's value.
+func (s *R53ResourceRecord) SetRecordSetId(v string) *R53ResourceRecord {
+ s.RecordSetId = &v
+ return s
+}
+
+// A resource used for checking the readiness of a Resource Set
+type ReadinessCheckOutput_ struct {
+ _ struct{} `type:"structure"`
+
+ // Arn associated with ReadinessCheck
+ //
+ // ReadinessCheckArn is a required field
+ ReadinessCheckArn *string `locationName:"readinessCheckArn" type:"string" required:"true"`
+
+ // Name for a ReadinessCheck
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"`
+
+ // Name of the ResourceSet to be checked
+ //
+ // ResourceSet is a required field
+ ResourceSet *string `locationName:"resourceSet" type:"string" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s ReadinessCheckOutput_) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ReadinessCheckOutput_) GoString() string {
+ return s.String()
+}
+
+// SetReadinessCheckArn sets the ReadinessCheckArn field's value.
+func (s *ReadinessCheckOutput_) SetReadinessCheckArn(v string) *ReadinessCheckOutput_ {
+ s.ReadinessCheckArn = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *ReadinessCheckOutput_) SetReadinessCheckName(v string) *ReadinessCheckOutput_ {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSet sets the ResourceSet field's value.
+func (s *ReadinessCheckOutput_) SetResourceSet(v string) *ReadinessCheckOutput_ {
+ s.ResourceSet = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *ReadinessCheckOutput_) SetTags(v map[string]*string) *ReadinessCheckOutput_ {
+ s.Tags = v
+ return s
+}
+
+// Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary
+// and GetCellReadinessSummary
+type ReadinessCheckSummary struct {
+ _ struct{} `type:"structure"`
+
+ // The readiness of this ReadinessCheck
+ Readiness *string `locationName:"readiness" type:"string" enum:"Readiness"`
+
+ // The name of a ReadinessCheck which is part of the given RecoveryGroup or
+ // Cell
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"`
+}
+
+// String returns the string representation
+func (s ReadinessCheckSummary) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ReadinessCheckSummary) GoString() string {
+ return s.String()
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *ReadinessCheckSummary) SetReadiness(v string) *ReadinessCheckSummary {
+ s.Readiness = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *ReadinessCheckSummary) SetReadinessCheckName(v string) *ReadinessCheckSummary {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// Guidance for improving Recovery Group resilliancy
+type Recommendation struct {
+ _ struct{} `type:"structure"`
+
+ // Guidance text for recommendation
+ //
+ // RecommendationText is a required field
+ RecommendationText *string `locationName:"recommendationText" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s Recommendation) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s Recommendation) GoString() string {
+ return s.String()
+}
+
+// SetRecommendationText sets the RecommendationText field's value.
+func (s *Recommendation) SetRecommendationText(v string) *Recommendation {
+ s.RecommendationText = &v
+ return s
+}
+
+// A Recovery Group generally containing multiple Cells
+type RecoveryGroupOutput_ struct {
+ _ struct{} `type:"structure"`
+
+ // A list of Cell arns
+ //
+ // Cells is a required field
+ Cells []*string `locationName:"cells" type:"list" required:"true"`
+
+ // The arn for the RecoveryGroup
+ //
+ // RecoveryGroupArn is a required field
+ RecoveryGroupArn *string `locationName:"recoveryGroupArn" type:"string" required:"true"`
+
+ // The name of the RecoveryGroup
+ //
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s RecoveryGroupOutput_) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RecoveryGroupOutput_) GoString() string {
+ return s.String()
+}
+
+// SetCells sets the Cells field's value.
+func (s *RecoveryGroupOutput_) SetCells(v []*string) *RecoveryGroupOutput_ {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupArn sets the RecoveryGroupArn field's value.
+func (s *RecoveryGroupOutput_) SetRecoveryGroupArn(v string) *RecoveryGroupOutput_ {
+ s.RecoveryGroupArn = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *RecoveryGroupOutput_) SetRecoveryGroupName(v string) *RecoveryGroupOutput_ {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *RecoveryGroupOutput_) SetTags(v map[string]*string) *RecoveryGroupOutput_ {
+ s.Tags = v
+ return s
+}
+
+// The resource element of a ResourceSet
+type Resource struct {
+ _ struct{} `type:"structure"`
+
+ // The component id of the resource, generated by the service when dnsTargetResource
+ // is used
+ ComponentId *string `locationName:"componentId" type:"string"`
+
+ // A component for DNS/Routing Control Readiness Checks
+ DnsTargetResource *DNSTargetResource `locationName:"dnsTargetResource" type:"structure"`
+
+ // A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained
+ // within.
+ ReadinessScopes []*string `locationName:"readinessScopes" type:"list"`
+
+ // The ARN of the AWS resource, can be skipped if dnsTargetResource is used
+ ResourceArn *string `locationName:"resourceArn" type:"string"`
+}
+
+// String returns the string representation
+func (s Resource) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s Resource) GoString() string {
+ return s.String()
+}
+
+// SetComponentId sets the ComponentId field's value.
+func (s *Resource) SetComponentId(v string) *Resource {
+ s.ComponentId = &v
+ return s
+}
+
+// SetDnsTargetResource sets the DnsTargetResource field's value.
+func (s *Resource) SetDnsTargetResource(v *DNSTargetResource) *Resource {
+ s.DnsTargetResource = v
+ return s
+}
+
+// SetReadinessScopes sets the ReadinessScopes field's value.
+func (s *Resource) SetReadinessScopes(v []*string) *Resource {
+ s.ReadinessScopes = v
+ return s
+}
+
+// SetResourceArn sets the ResourceArn field's value.
+func (s *Resource) SetResourceArn(v string) *Resource {
+ s.ResourceArn = &v
+ return s
+}
+
+type ResourceNotFoundException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ResourceNotFoundException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ResourceNotFoundException) GoString() string {
+ return s.String()
+}
+
+func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error {
+ return &ResourceNotFoundException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ResourceNotFoundException) Code() string {
+ return "ResourceNotFoundException"
+}
+
+// Message returns the exception's message.
+func (s *ResourceNotFoundException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ResourceNotFoundException) OrigErr() error {
+ return nil
+}
+
+func (s *ResourceNotFoundException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ResourceNotFoundException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ResourceNotFoundException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// Result with status for an individual resource.
+type ResourceResult struct {
+ _ struct{} `type:"structure"`
+
+ // The component id of the resource
+ ComponentId *string `locationName:"componentId" type:"string"`
+
+ // The time the resource was last checked for readiness, in ISO-8601 format,
+ // UTC.
+ //
+ // LastCheckedTimestamp is a required field
+ LastCheckedTimestamp *time.Time `locationName:"lastCheckedTimestamp" type:"timestamp" timestampFormat:"iso8601" required:"true"`
+
+ // The readiness of the resource.
+ //
+ // Readiness is a required field
+ Readiness *string `locationName:"readiness" type:"string" required:"true" enum:"Readiness"`
+
+ // The ARN of the resource
+ ResourceArn *string `locationName:"resourceArn" type:"string"`
+}
+
+// String returns the string representation
+func (s ResourceResult) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ResourceResult) GoString() string {
+ return s.String()
+}
+
+// SetComponentId sets the ComponentId field's value.
+func (s *ResourceResult) SetComponentId(v string) *ResourceResult {
+ s.ComponentId = &v
+ return s
+}
+
+// SetLastCheckedTimestamp sets the LastCheckedTimestamp field's value.
+func (s *ResourceResult) SetLastCheckedTimestamp(v time.Time) *ResourceResult {
+ s.LastCheckedTimestamp = &v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *ResourceResult) SetReadiness(v string) *ResourceResult {
+ s.Readiness = &v
+ return s
+}
+
+// SetResourceArn sets the ResourceArn field's value.
+func (s *ResourceResult) SetResourceArn(v string) *ResourceResult {
+ s.ResourceArn = &v
+ return s
+}
+
+// A collection of resources of the same type
+type ResourceSetOutput_ struct {
+ _ struct{} `type:"structure"`
+
+ // The arn for the ResourceSet
+ //
+ // ResourceSetArn is a required field
+ ResourceSetArn *string `locationName:"resourceSetArn" type:"string" required:"true"`
+
+ // The name of the ResourceSet
+ //
+ // ResourceSetName is a required field
+ ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"`
+
+ // AWS Resource Type of the resources in the ResourceSet
+ //
+ // ResourceSetType is a required field
+ ResourceSetType *string `locationName:"resourceSetType" type:"string" required:"true"`
+
+ // A list of Resource objects
+ //
+ // Resources is a required field
+ Resources []*Resource `locationName:"resources" type:"list" required:"true"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s ResourceSetOutput_) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ResourceSetOutput_) GoString() string {
+ return s.String()
+}
+
+// SetResourceSetArn sets the ResourceSetArn field's value.
+func (s *ResourceSetOutput_) SetResourceSetArn(v string) *ResourceSetOutput_ {
+ s.ResourceSetArn = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *ResourceSetOutput_) SetResourceSetName(v string) *ResourceSetOutput_ {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *ResourceSetOutput_) SetResourceSetType(v string) *ResourceSetOutput_ {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *ResourceSetOutput_) SetResources(v []*Resource) *ResourceSetOutput_ {
+ s.Resources = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *ResourceSetOutput_) SetTags(v map[string]*string) *ResourceSetOutput_ {
+ s.Tags = v
+ return s
+}
+
+// Result with status for an individual rule..
+type RuleResult struct {
+ _ struct{} `type:"structure"`
+
+ // The time the resource was last checked for readiness, in ISO-8601 format,
+ // UTC.
+ //
+ // LastCheckedTimestamp is a required field
+ LastCheckedTimestamp *time.Time `locationName:"lastCheckedTimestamp" type:"timestamp" timestampFormat:"iso8601" required:"true"`
+
+ // Details about the resource's readiness
+ //
+ // Messages is a required field
+ Messages []*Message `locationName:"messages" type:"list" required:"true"`
+
+ // The readiness at rule level.
+ //
+ // Readiness is a required field
+ Readiness *string `locationName:"readiness" type:"string" required:"true" enum:"Readiness"`
+
+ // The identifier of the rule.
+ //
+ // RuleId is a required field
+ RuleId *string `locationName:"ruleId" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s RuleResult) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s RuleResult) GoString() string {
+ return s.String()
+}
+
+// SetLastCheckedTimestamp sets the LastCheckedTimestamp field's value.
+func (s *RuleResult) SetLastCheckedTimestamp(v time.Time) *RuleResult {
+ s.LastCheckedTimestamp = &v
+ return s
+}
+
+// SetMessages sets the Messages field's value.
+func (s *RuleResult) SetMessages(v []*Message) *RuleResult {
+ s.Messages = v
+ return s
+}
+
+// SetReadiness sets the Readiness field's value.
+func (s *RuleResult) SetReadiness(v string) *RuleResult {
+ s.Readiness = &v
+ return s
+}
+
+// SetRuleId sets the RuleId field's value.
+func (s *RuleResult) SetRuleId(v string) *RuleResult {
+ s.RuleId = &v
+ return s
+}
+
+type TagResourceInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceArn is a required field
+ ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
+
+ // A collection of tags associated with a resource
+ //
+ // Tags is a required field
+ Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
+}
+
+// String returns the string representation
+func (s TagResourceInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s TagResourceInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *TagResourceInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"}
+ if s.ResourceArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
+ }
+ if s.ResourceArn != nil && len(*s.ResourceArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1))
+ }
+ if s.Tags == nil {
+ invalidParams.Add(request.NewErrParamRequired("Tags"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceArn sets the ResourceArn field's value.
+func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput {
+ s.ResourceArn = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput {
+ s.Tags = v
+ return s
+}
+
+type TagResourceOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s TagResourceOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s TagResourceOutput) GoString() string {
+ return s.String()
+}
+
+// The target resource the R53 record points to
+type TargetResource struct {
+ _ struct{} `type:"structure"`
+
+ // The NLB resource a DNS Target Resource points to
+ NLBResource *NLBResource `locationName:"nLBResource" type:"structure"`
+
+ // The Route 53 resource a DNS Target Resource record points to
+ R53Resource *R53ResourceRecord `locationName:"r53Resource" type:"structure"`
+}
+
+// String returns the string representation
+func (s TargetResource) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s TargetResource) GoString() string {
+ return s.String()
+}
+
+// SetNLBResource sets the NLBResource field's value.
+func (s *TargetResource) SetNLBResource(v *NLBResource) *TargetResource {
+ s.NLBResource = v
+ return s
+}
+
+// SetR53Resource sets the R53Resource field's value.
+func (s *TargetResource) SetR53Resource(v *R53ResourceRecord) *TargetResource {
+ s.R53Resource = v
+ return s
+}
+
+type ThrottlingException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ThrottlingException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ThrottlingException) GoString() string {
+ return s.String()
+}
+
+func newErrorThrottlingException(v protocol.ResponseMetadata) error {
+ return &ThrottlingException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ThrottlingException) Code() string {
+ return "ThrottlingException"
+}
+
+// Message returns the exception's message.
+func (s *ThrottlingException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ThrottlingException) OrigErr() error {
+ return nil
+}
+
+func (s *ThrottlingException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ThrottlingException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ThrottlingException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+type UntagResourceInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceArn is a required field
+ ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
+
+ // TagKeys is a required field
+ TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
+}
+
+// String returns the string representation
+func (s UntagResourceInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UntagResourceInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UntagResourceInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"}
+ if s.ResourceArn == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceArn"))
+ }
+ if s.ResourceArn != nil && len(*s.ResourceArn) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1))
+ }
+ if s.TagKeys == nil {
+ invalidParams.Add(request.NewErrParamRequired("TagKeys"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceArn sets the ResourceArn field's value.
+func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput {
+ s.ResourceArn = &v
+ return s
+}
+
+// SetTagKeys sets the TagKeys field's value.
+func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput {
+ s.TagKeys = v
+ return s
+}
+
+type UntagResourceOutput struct {
+ _ struct{} `type:"structure"`
+}
+
+// String returns the string representation
+func (s UntagResourceOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UntagResourceOutput) GoString() string {
+ return s.String()
+}
+
+type UpdateCellInput struct {
+ _ struct{} `type:"structure"`
+
+ // CellName is a required field
+ CellName *string `location:"uri" locationName:"cellName" type:"string" required:"true"`
+
+ // Cells is a required field
+ Cells []*string `locationName:"cells" type:"list" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateCellInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateCellInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateCellInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateCellInput"}
+ if s.CellName == nil {
+ invalidParams.Add(request.NewErrParamRequired("CellName"))
+ }
+ if s.CellName != nil && len(*s.CellName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("CellName", 1))
+ }
+ if s.Cells == nil {
+ invalidParams.Add(request.NewErrParamRequired("Cells"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCellName sets the CellName field's value.
+func (s *UpdateCellInput) SetCellName(v string) *UpdateCellInput {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *UpdateCellInput) SetCells(v []*string) *UpdateCellInput {
+ s.Cells = v
+ return s
+}
+
+type UpdateCellOutput struct {
+ _ struct{} `type:"structure"`
+
+ CellArn *string `locationName:"cellArn" type:"string"`
+
+ CellName *string `locationName:"cellName" type:"string"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ ParentReadinessScopes []*string `locationName:"parentReadinessScopes" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s UpdateCellOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateCellOutput) GoString() string {
+ return s.String()
+}
+
+// SetCellArn sets the CellArn field's value.
+func (s *UpdateCellOutput) SetCellArn(v string) *UpdateCellOutput {
+ s.CellArn = &v
+ return s
+}
+
+// SetCellName sets the CellName field's value.
+func (s *UpdateCellOutput) SetCellName(v string) *UpdateCellOutput {
+ s.CellName = &v
+ return s
+}
+
+// SetCells sets the Cells field's value.
+func (s *UpdateCellOutput) SetCells(v []*string) *UpdateCellOutput {
+ s.Cells = v
+ return s
+}
+
+// SetParentReadinessScopes sets the ParentReadinessScopes field's value.
+func (s *UpdateCellOutput) SetParentReadinessScopes(v []*string) *UpdateCellOutput {
+ s.ParentReadinessScopes = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *UpdateCellOutput) SetTags(v map[string]*string) *UpdateCellOutput {
+ s.Tags = v
+ return s
+}
+
+type UpdateReadinessCheckInput struct {
+ _ struct{} `type:"structure"`
+
+ // ReadinessCheckName is a required field
+ ReadinessCheckName *string `location:"uri" locationName:"readinessCheckName" type:"string" required:"true"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `locationName:"resourceSetName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateReadinessCheckInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateReadinessCheckInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateReadinessCheckInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateReadinessCheckInput"}
+ if s.ReadinessCheckName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ReadinessCheckName"))
+ }
+ if s.ReadinessCheckName != nil && len(*s.ReadinessCheckName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ReadinessCheckName", 1))
+ }
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *UpdateReadinessCheckInput) SetReadinessCheckName(v string) *UpdateReadinessCheckInput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *UpdateReadinessCheckInput) SetResourceSetName(v string) *UpdateReadinessCheckInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+type UpdateReadinessCheckOutput struct {
+ _ struct{} `type:"structure"`
+
+ ReadinessCheckArn *string `locationName:"readinessCheckArn" type:"string"`
+
+ ReadinessCheckName *string `locationName:"readinessCheckName" type:"string"`
+
+ ResourceSet *string `locationName:"resourceSet" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s UpdateReadinessCheckOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateReadinessCheckOutput) GoString() string {
+ return s.String()
+}
+
+// SetReadinessCheckArn sets the ReadinessCheckArn field's value.
+func (s *UpdateReadinessCheckOutput) SetReadinessCheckArn(v string) *UpdateReadinessCheckOutput {
+ s.ReadinessCheckArn = &v
+ return s
+}
+
+// SetReadinessCheckName sets the ReadinessCheckName field's value.
+func (s *UpdateReadinessCheckOutput) SetReadinessCheckName(v string) *UpdateReadinessCheckOutput {
+ s.ReadinessCheckName = &v
+ return s
+}
+
+// SetResourceSet sets the ResourceSet field's value.
+func (s *UpdateReadinessCheckOutput) SetResourceSet(v string) *UpdateReadinessCheckOutput {
+ s.ResourceSet = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *UpdateReadinessCheckOutput) SetTags(v map[string]*string) *UpdateReadinessCheckOutput {
+ s.Tags = v
+ return s
+}
+
+type UpdateRecoveryGroupInput struct {
+ _ struct{} `type:"structure"`
+
+ // Cells is a required field
+ Cells []*string `locationName:"cells" type:"list" required:"true"`
+
+ // RecoveryGroupName is a required field
+ RecoveryGroupName *string `location:"uri" locationName:"recoveryGroupName" type:"string" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateRecoveryGroupInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRecoveryGroupInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateRecoveryGroupInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateRecoveryGroupInput"}
+ if s.Cells == nil {
+ invalidParams.Add(request.NewErrParamRequired("Cells"))
+ }
+ if s.RecoveryGroupName == nil {
+ invalidParams.Add(request.NewErrParamRequired("RecoveryGroupName"))
+ }
+ if s.RecoveryGroupName != nil && len(*s.RecoveryGroupName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("RecoveryGroupName", 1))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetCells sets the Cells field's value.
+func (s *UpdateRecoveryGroupInput) SetCells(v []*string) *UpdateRecoveryGroupInput {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *UpdateRecoveryGroupInput) SetRecoveryGroupName(v string) *UpdateRecoveryGroupInput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+type UpdateRecoveryGroupOutput struct {
+ _ struct{} `type:"structure"`
+
+ Cells []*string `locationName:"cells" type:"list"`
+
+ RecoveryGroupArn *string `locationName:"recoveryGroupArn" type:"string"`
+
+ RecoveryGroupName *string `locationName:"recoveryGroupName" type:"string"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s UpdateRecoveryGroupOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateRecoveryGroupOutput) GoString() string {
+ return s.String()
+}
+
+// SetCells sets the Cells field's value.
+func (s *UpdateRecoveryGroupOutput) SetCells(v []*string) *UpdateRecoveryGroupOutput {
+ s.Cells = v
+ return s
+}
+
+// SetRecoveryGroupArn sets the RecoveryGroupArn field's value.
+func (s *UpdateRecoveryGroupOutput) SetRecoveryGroupArn(v string) *UpdateRecoveryGroupOutput {
+ s.RecoveryGroupArn = &v
+ return s
+}
+
+// SetRecoveryGroupName sets the RecoveryGroupName field's value.
+func (s *UpdateRecoveryGroupOutput) SetRecoveryGroupName(v string) *UpdateRecoveryGroupOutput {
+ s.RecoveryGroupName = &v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *UpdateRecoveryGroupOutput) SetTags(v map[string]*string) *UpdateRecoveryGroupOutput {
+ s.Tags = v
+ return s
+}
+
+type UpdateResourceSetInput struct {
+ _ struct{} `type:"structure"`
+
+ // ResourceSetName is a required field
+ ResourceSetName *string `location:"uri" locationName:"resourceSetName" type:"string" required:"true"`
+
+ // ResourceSetType is a required field
+ ResourceSetType *string `locationName:"resourceSetType" type:"string" required:"true"`
+
+ // Resources is a required field
+ Resources []*Resource `locationName:"resources" type:"list" required:"true"`
+}
+
+// String returns the string representation
+func (s UpdateResourceSetInput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateResourceSetInput) GoString() string {
+ return s.String()
+}
+
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *UpdateResourceSetInput) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "UpdateResourceSetInput"}
+ if s.ResourceSetName == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetName"))
+ }
+ if s.ResourceSetName != nil && len(*s.ResourceSetName) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("ResourceSetName", 1))
+ }
+ if s.ResourceSetType == nil {
+ invalidParams.Add(request.NewErrParamRequired("ResourceSetType"))
+ }
+ if s.Resources == nil {
+ invalidParams.Add(request.NewErrParamRequired("Resources"))
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *UpdateResourceSetInput) SetResourceSetName(v string) *UpdateResourceSetInput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *UpdateResourceSetInput) SetResourceSetType(v string) *UpdateResourceSetInput {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *UpdateResourceSetInput) SetResources(v []*Resource) *UpdateResourceSetInput {
+ s.Resources = v
+ return s
+}
+
+type UpdateResourceSetOutput struct {
+ _ struct{} `type:"structure"`
+
+ ResourceSetArn *string `locationName:"resourceSetArn" type:"string"`
+
+ ResourceSetName *string `locationName:"resourceSetName" type:"string"`
+
+ ResourceSetType *string `locationName:"resourceSetType" type:"string"`
+
+ Resources []*Resource `locationName:"resources" type:"list"`
+
+ // A collection of tags associated with a resource
+ Tags map[string]*string `locationName:"tags" type:"map"`
+}
+
+// String returns the string representation
+func (s UpdateResourceSetOutput) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s UpdateResourceSetOutput) GoString() string {
+ return s.String()
+}
+
+// SetResourceSetArn sets the ResourceSetArn field's value.
+func (s *UpdateResourceSetOutput) SetResourceSetArn(v string) *UpdateResourceSetOutput {
+ s.ResourceSetArn = &v
+ return s
+}
+
+// SetResourceSetName sets the ResourceSetName field's value.
+func (s *UpdateResourceSetOutput) SetResourceSetName(v string) *UpdateResourceSetOutput {
+ s.ResourceSetName = &v
+ return s
+}
+
+// SetResourceSetType sets the ResourceSetType field's value.
+func (s *UpdateResourceSetOutput) SetResourceSetType(v string) *UpdateResourceSetOutput {
+ s.ResourceSetType = &v
+ return s
+}
+
+// SetResources sets the Resources field's value.
+func (s *UpdateResourceSetOutput) SetResources(v []*Resource) *UpdateResourceSetOutput {
+ s.Resources = v
+ return s
+}
+
+// SetTags sets the Tags field's value.
+func (s *UpdateResourceSetOutput) SetTags(v map[string]*string) *UpdateResourceSetOutput {
+ s.Tags = v
+ return s
+}
+
+type ValidationException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ValidationException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ValidationException) GoString() string {
+ return s.String()
+}
+
+func newErrorValidationException(v protocol.ResponseMetadata) error {
+ return &ValidationException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ValidationException) Code() string {
+ return "ValidationException"
+}
+
+// Message returns the exception's message.
+func (s *ValidationException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ValidationException) OrigErr() error {
+ return nil
+}
+
+func (s *ValidationException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ValidationException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ValidationException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
+// The readiness of an entire ReadinessCheck or an individual resource ARN.
+const (
+ // ReadinessReady is a Readiness enum value
+ ReadinessReady = "READY"
+
+ // ReadinessNotReady is a Readiness enum value
+ ReadinessNotReady = "NOT_READY"
+
+ // ReadinessUnknown is a Readiness enum value
+ ReadinessUnknown = "UNKNOWN"
+
+ // ReadinessNotAuthorized is a Readiness enum value
+ ReadinessNotAuthorized = "NOT_AUTHORIZED"
+)
+
+// Readiness_Values returns all elements of the Readiness enum
+func Readiness_Values() []string {
+ return []string{
+ ReadinessReady,
+ ReadinessNotReady,
+ ReadinessUnknown,
+ ReadinessNotAuthorized,
+ }
+}
diff --git a/service/route53recoveryreadiness/doc.go b/service/route53recoveryreadiness/doc.go
new file mode 100644
index 0000000000..b04626ff1b
--- /dev/null
+++ b/service/route53recoveryreadiness/doc.go
@@ -0,0 +1,28 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoveryreadiness provides the client and types for making API
+// requests to AWS Route53 Recovery Readiness.
+//
+// AWS Route53 Recovery Readiness
+//
+// See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-readiness-2019-12-02 for more information on this service.
+//
+// See route53recoveryreadiness package documentation for more information.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoveryreadiness/
+//
+// Using the Client
+//
+// To contact AWS Route53 Recovery Readiness with the SDK use the New function to create
+// a new service client. With that client you can make API requests to the service.
+// These clients are safe to use concurrently.
+//
+// See the SDK's documentation for more information on how to use the SDK.
+// https://docs.aws.amazon.com/sdk-for-go/api/
+//
+// See aws.Config documentation for more information on configuring SDK clients.
+// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
+//
+// See the AWS Route53 Recovery Readiness client Route53RecoveryReadiness for more
+// information on creating client for this service.
+// https://docs.aws.amazon.com/sdk-for-go/api/service/route53recoveryreadiness/#New
+package route53recoveryreadiness
diff --git a/service/route53recoveryreadiness/errors.go b/service/route53recoveryreadiness/errors.go
new file mode 100644
index 0000000000..eae2013341
--- /dev/null
+++ b/service/route53recoveryreadiness/errors.go
@@ -0,0 +1,43 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoveryreadiness
+
+import (
+ "github.com/aws/aws-sdk-go/private/protocol"
+)
+
+const (
+
+ // ErrCodeAccessDeniedException for service response error code
+ // "AccessDeniedException".
+ ErrCodeAccessDeniedException = "AccessDeniedException"
+
+ // ErrCodeConflictException for service response error code
+ // "ConflictException".
+ ErrCodeConflictException = "ConflictException"
+
+ // ErrCodeInternalServerException for service response error code
+ // "InternalServerException".
+ ErrCodeInternalServerException = "InternalServerException"
+
+ // ErrCodeResourceNotFoundException for service response error code
+ // "ResourceNotFoundException".
+ ErrCodeResourceNotFoundException = "ResourceNotFoundException"
+
+ // ErrCodeThrottlingException for service response error code
+ // "ThrottlingException".
+ ErrCodeThrottlingException = "ThrottlingException"
+
+ // ErrCodeValidationException for service response error code
+ // "ValidationException".
+ ErrCodeValidationException = "ValidationException"
+)
+
+var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{
+ "AccessDeniedException": newErrorAccessDeniedException,
+ "ConflictException": newErrorConflictException,
+ "InternalServerException": newErrorInternalServerException,
+ "ResourceNotFoundException": newErrorResourceNotFoundException,
+ "ThrottlingException": newErrorThrottlingException,
+ "ValidationException": newErrorValidationException,
+}
diff --git a/service/route53recoveryreadiness/route53recoveryreadinessiface/interface.go b/service/route53recoveryreadiness/route53recoveryreadinessiface/interface.go
new file mode 100644
index 0000000000..ee0a0c55d9
--- /dev/null
+++ b/service/route53recoveryreadiness/route53recoveryreadinessiface/interface.go
@@ -0,0 +1,222 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+// Package route53recoveryreadinessiface provides an interface to enable mocking the AWS Route53 Recovery Readiness service client
+// for testing your code.
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters.
+package route53recoveryreadinessiface
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/service/route53recoveryreadiness"
+)
+
+// Route53RecoveryReadinessAPI provides an interface to enable mocking the
+// route53recoveryreadiness.Route53RecoveryReadiness service client's API operation,
+// paginators, and waiters. This make unit testing your code that calls out
+// to the SDK's service client's calls easier.
+//
+// The best way to use this interface is so the SDK's service client's calls
+// can be stubbed out for unit testing your code with the SDK without needing
+// to inject custom request handlers into the SDK's request pipeline.
+//
+// // myFunc uses an SDK service client to make a request to
+// // AWS Route53 Recovery Readiness.
+// func myFunc(svc route53recoveryreadinessiface.Route53RecoveryReadinessAPI) bool {
+// // Make svc.CreateCell request
+// }
+//
+// func main() {
+// sess := session.New()
+// svc := route53recoveryreadiness.New(sess)
+//
+// myFunc(svc)
+// }
+//
+// In your _test.go file:
+//
+// // Define a mock struct to be used in your unit tests of myFunc.
+// type mockRoute53RecoveryReadinessClient struct {
+// route53recoveryreadinessiface.Route53RecoveryReadinessAPI
+// }
+// func (m *mockRoute53RecoveryReadinessClient) CreateCell(input *route53recoveryreadiness.CreateCellInput) (*route53recoveryreadiness.CreateCellOutput, error) {
+// // mock response/functionality
+// }
+//
+// func TestMyFunc(t *testing.T) {
+// // Setup Test
+// mockSvc := &mockRoute53RecoveryReadinessClient{}
+//
+// myfunc(mockSvc)
+//
+// // Verify myFunc's functionality
+// }
+//
+// It is important to note that this interface will have breaking changes
+// when the service model is updated and adds new API operations, paginators,
+// and waiters. Its suggested to use the pattern above for testing, or using
+// tooling to generate mocks to satisfy the interfaces.
+type Route53RecoveryReadinessAPI interface {
+ CreateCell(*route53recoveryreadiness.CreateCellInput) (*route53recoveryreadiness.CreateCellOutput, error)
+ CreateCellWithContext(aws.Context, *route53recoveryreadiness.CreateCellInput, ...request.Option) (*route53recoveryreadiness.CreateCellOutput, error)
+ CreateCellRequest(*route53recoveryreadiness.CreateCellInput) (*request.Request, *route53recoveryreadiness.CreateCellOutput)
+
+ CreateCrossAccountAuthorization(*route53recoveryreadiness.CreateCrossAccountAuthorizationInput) (*route53recoveryreadiness.CreateCrossAccountAuthorizationOutput, error)
+ CreateCrossAccountAuthorizationWithContext(aws.Context, *route53recoveryreadiness.CreateCrossAccountAuthorizationInput, ...request.Option) (*route53recoveryreadiness.CreateCrossAccountAuthorizationOutput, error)
+ CreateCrossAccountAuthorizationRequest(*route53recoveryreadiness.CreateCrossAccountAuthorizationInput) (*request.Request, *route53recoveryreadiness.CreateCrossAccountAuthorizationOutput)
+
+ CreateReadinessCheck(*route53recoveryreadiness.CreateReadinessCheckInput) (*route53recoveryreadiness.CreateReadinessCheckOutput, error)
+ CreateReadinessCheckWithContext(aws.Context, *route53recoveryreadiness.CreateReadinessCheckInput, ...request.Option) (*route53recoveryreadiness.CreateReadinessCheckOutput, error)
+ CreateReadinessCheckRequest(*route53recoveryreadiness.CreateReadinessCheckInput) (*request.Request, *route53recoveryreadiness.CreateReadinessCheckOutput)
+
+ CreateRecoveryGroup(*route53recoveryreadiness.CreateRecoveryGroupInput) (*route53recoveryreadiness.CreateRecoveryGroupOutput, error)
+ CreateRecoveryGroupWithContext(aws.Context, *route53recoveryreadiness.CreateRecoveryGroupInput, ...request.Option) (*route53recoveryreadiness.CreateRecoveryGroupOutput, error)
+ CreateRecoveryGroupRequest(*route53recoveryreadiness.CreateRecoveryGroupInput) (*request.Request, *route53recoveryreadiness.CreateRecoveryGroupOutput)
+
+ CreateResourceSet(*route53recoveryreadiness.CreateResourceSetInput) (*route53recoveryreadiness.CreateResourceSetOutput, error)
+ CreateResourceSetWithContext(aws.Context, *route53recoveryreadiness.CreateResourceSetInput, ...request.Option) (*route53recoveryreadiness.CreateResourceSetOutput, error)
+ CreateResourceSetRequest(*route53recoveryreadiness.CreateResourceSetInput) (*request.Request, *route53recoveryreadiness.CreateResourceSetOutput)
+
+ DeleteCell(*route53recoveryreadiness.DeleteCellInput) (*route53recoveryreadiness.DeleteCellOutput, error)
+ DeleteCellWithContext(aws.Context, *route53recoveryreadiness.DeleteCellInput, ...request.Option) (*route53recoveryreadiness.DeleteCellOutput, error)
+ DeleteCellRequest(*route53recoveryreadiness.DeleteCellInput) (*request.Request, *route53recoveryreadiness.DeleteCellOutput)
+
+ DeleteCrossAccountAuthorization(*route53recoveryreadiness.DeleteCrossAccountAuthorizationInput) (*route53recoveryreadiness.DeleteCrossAccountAuthorizationOutput, error)
+ DeleteCrossAccountAuthorizationWithContext(aws.Context, *route53recoveryreadiness.DeleteCrossAccountAuthorizationInput, ...request.Option) (*route53recoveryreadiness.DeleteCrossAccountAuthorizationOutput, error)
+ DeleteCrossAccountAuthorizationRequest(*route53recoveryreadiness.DeleteCrossAccountAuthorizationInput) (*request.Request, *route53recoveryreadiness.DeleteCrossAccountAuthorizationOutput)
+
+ DeleteReadinessCheck(*route53recoveryreadiness.DeleteReadinessCheckInput) (*route53recoveryreadiness.DeleteReadinessCheckOutput, error)
+ DeleteReadinessCheckWithContext(aws.Context, *route53recoveryreadiness.DeleteReadinessCheckInput, ...request.Option) (*route53recoveryreadiness.DeleteReadinessCheckOutput, error)
+ DeleteReadinessCheckRequest(*route53recoveryreadiness.DeleteReadinessCheckInput) (*request.Request, *route53recoveryreadiness.DeleteReadinessCheckOutput)
+
+ DeleteRecoveryGroup(*route53recoveryreadiness.DeleteRecoveryGroupInput) (*route53recoveryreadiness.DeleteRecoveryGroupOutput, error)
+ DeleteRecoveryGroupWithContext(aws.Context, *route53recoveryreadiness.DeleteRecoveryGroupInput, ...request.Option) (*route53recoveryreadiness.DeleteRecoveryGroupOutput, error)
+ DeleteRecoveryGroupRequest(*route53recoveryreadiness.DeleteRecoveryGroupInput) (*request.Request, *route53recoveryreadiness.DeleteRecoveryGroupOutput)
+
+ DeleteResourceSet(*route53recoveryreadiness.DeleteResourceSetInput) (*route53recoveryreadiness.DeleteResourceSetOutput, error)
+ DeleteResourceSetWithContext(aws.Context, *route53recoveryreadiness.DeleteResourceSetInput, ...request.Option) (*route53recoveryreadiness.DeleteResourceSetOutput, error)
+ DeleteResourceSetRequest(*route53recoveryreadiness.DeleteResourceSetInput) (*request.Request, *route53recoveryreadiness.DeleteResourceSetOutput)
+
+ GetArchitectureRecommendations(*route53recoveryreadiness.GetArchitectureRecommendationsInput) (*route53recoveryreadiness.GetArchitectureRecommendationsOutput, error)
+ GetArchitectureRecommendationsWithContext(aws.Context, *route53recoveryreadiness.GetArchitectureRecommendationsInput, ...request.Option) (*route53recoveryreadiness.GetArchitectureRecommendationsOutput, error)
+ GetArchitectureRecommendationsRequest(*route53recoveryreadiness.GetArchitectureRecommendationsInput) (*request.Request, *route53recoveryreadiness.GetArchitectureRecommendationsOutput)
+
+ GetCell(*route53recoveryreadiness.GetCellInput) (*route53recoveryreadiness.GetCellOutput, error)
+ GetCellWithContext(aws.Context, *route53recoveryreadiness.GetCellInput, ...request.Option) (*route53recoveryreadiness.GetCellOutput, error)
+ GetCellRequest(*route53recoveryreadiness.GetCellInput) (*request.Request, *route53recoveryreadiness.GetCellOutput)
+
+ GetCellReadinessSummary(*route53recoveryreadiness.GetCellReadinessSummaryInput) (*route53recoveryreadiness.GetCellReadinessSummaryOutput, error)
+ GetCellReadinessSummaryWithContext(aws.Context, *route53recoveryreadiness.GetCellReadinessSummaryInput, ...request.Option) (*route53recoveryreadiness.GetCellReadinessSummaryOutput, error)
+ GetCellReadinessSummaryRequest(*route53recoveryreadiness.GetCellReadinessSummaryInput) (*request.Request, *route53recoveryreadiness.GetCellReadinessSummaryOutput)
+
+ GetCellReadinessSummaryPages(*route53recoveryreadiness.GetCellReadinessSummaryInput, func(*route53recoveryreadiness.GetCellReadinessSummaryOutput, bool) bool) error
+ GetCellReadinessSummaryPagesWithContext(aws.Context, *route53recoveryreadiness.GetCellReadinessSummaryInput, func(*route53recoveryreadiness.GetCellReadinessSummaryOutput, bool) bool, ...request.Option) error
+
+ GetReadinessCheck(*route53recoveryreadiness.GetReadinessCheckInput) (*route53recoveryreadiness.GetReadinessCheckOutput, error)
+ GetReadinessCheckWithContext(aws.Context, *route53recoveryreadiness.GetReadinessCheckInput, ...request.Option) (*route53recoveryreadiness.GetReadinessCheckOutput, error)
+ GetReadinessCheckRequest(*route53recoveryreadiness.GetReadinessCheckInput) (*request.Request, *route53recoveryreadiness.GetReadinessCheckOutput)
+
+ GetReadinessCheckResourceStatus(*route53recoveryreadiness.GetReadinessCheckResourceStatusInput) (*route53recoveryreadiness.GetReadinessCheckResourceStatusOutput, error)
+ GetReadinessCheckResourceStatusWithContext(aws.Context, *route53recoveryreadiness.GetReadinessCheckResourceStatusInput, ...request.Option) (*route53recoveryreadiness.GetReadinessCheckResourceStatusOutput, error)
+ GetReadinessCheckResourceStatusRequest(*route53recoveryreadiness.GetReadinessCheckResourceStatusInput) (*request.Request, *route53recoveryreadiness.GetReadinessCheckResourceStatusOutput)
+
+ GetReadinessCheckResourceStatusPages(*route53recoveryreadiness.GetReadinessCheckResourceStatusInput, func(*route53recoveryreadiness.GetReadinessCheckResourceStatusOutput, bool) bool) error
+ GetReadinessCheckResourceStatusPagesWithContext(aws.Context, *route53recoveryreadiness.GetReadinessCheckResourceStatusInput, func(*route53recoveryreadiness.GetReadinessCheckResourceStatusOutput, bool) bool, ...request.Option) error
+
+ GetReadinessCheckStatus(*route53recoveryreadiness.GetReadinessCheckStatusInput) (*route53recoveryreadiness.GetReadinessCheckStatusOutput, error)
+ GetReadinessCheckStatusWithContext(aws.Context, *route53recoveryreadiness.GetReadinessCheckStatusInput, ...request.Option) (*route53recoveryreadiness.GetReadinessCheckStatusOutput, error)
+ GetReadinessCheckStatusRequest(*route53recoveryreadiness.GetReadinessCheckStatusInput) (*request.Request, *route53recoveryreadiness.GetReadinessCheckStatusOutput)
+
+ GetReadinessCheckStatusPages(*route53recoveryreadiness.GetReadinessCheckStatusInput, func(*route53recoveryreadiness.GetReadinessCheckStatusOutput, bool) bool) error
+ GetReadinessCheckStatusPagesWithContext(aws.Context, *route53recoveryreadiness.GetReadinessCheckStatusInput, func(*route53recoveryreadiness.GetReadinessCheckStatusOutput, bool) bool, ...request.Option) error
+
+ GetRecoveryGroup(*route53recoveryreadiness.GetRecoveryGroupInput) (*route53recoveryreadiness.GetRecoveryGroupOutput, error)
+ GetRecoveryGroupWithContext(aws.Context, *route53recoveryreadiness.GetRecoveryGroupInput, ...request.Option) (*route53recoveryreadiness.GetRecoveryGroupOutput, error)
+ GetRecoveryGroupRequest(*route53recoveryreadiness.GetRecoveryGroupInput) (*request.Request, *route53recoveryreadiness.GetRecoveryGroupOutput)
+
+ GetRecoveryGroupReadinessSummary(*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryInput) (*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput, error)
+ GetRecoveryGroupReadinessSummaryWithContext(aws.Context, *route53recoveryreadiness.GetRecoveryGroupReadinessSummaryInput, ...request.Option) (*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput, error)
+ GetRecoveryGroupReadinessSummaryRequest(*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryInput) (*request.Request, *route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput)
+
+ GetRecoveryGroupReadinessSummaryPages(*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryInput, func(*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput, bool) bool) error
+ GetRecoveryGroupReadinessSummaryPagesWithContext(aws.Context, *route53recoveryreadiness.GetRecoveryGroupReadinessSummaryInput, func(*route53recoveryreadiness.GetRecoveryGroupReadinessSummaryOutput, bool) bool, ...request.Option) error
+
+ GetResourceSet(*route53recoveryreadiness.GetResourceSetInput) (*route53recoveryreadiness.GetResourceSetOutput, error)
+ GetResourceSetWithContext(aws.Context, *route53recoveryreadiness.GetResourceSetInput, ...request.Option) (*route53recoveryreadiness.GetResourceSetOutput, error)
+ GetResourceSetRequest(*route53recoveryreadiness.GetResourceSetInput) (*request.Request, *route53recoveryreadiness.GetResourceSetOutput)
+
+ ListCells(*route53recoveryreadiness.ListCellsInput) (*route53recoveryreadiness.ListCellsOutput, error)
+ ListCellsWithContext(aws.Context, *route53recoveryreadiness.ListCellsInput, ...request.Option) (*route53recoveryreadiness.ListCellsOutput, error)
+ ListCellsRequest(*route53recoveryreadiness.ListCellsInput) (*request.Request, *route53recoveryreadiness.ListCellsOutput)
+
+ ListCellsPages(*route53recoveryreadiness.ListCellsInput, func(*route53recoveryreadiness.ListCellsOutput, bool) bool) error
+ ListCellsPagesWithContext(aws.Context, *route53recoveryreadiness.ListCellsInput, func(*route53recoveryreadiness.ListCellsOutput, bool) bool, ...request.Option) error
+
+ ListCrossAccountAuthorizations(*route53recoveryreadiness.ListCrossAccountAuthorizationsInput) (*route53recoveryreadiness.ListCrossAccountAuthorizationsOutput, error)
+ ListCrossAccountAuthorizationsWithContext(aws.Context, *route53recoveryreadiness.ListCrossAccountAuthorizationsInput, ...request.Option) (*route53recoveryreadiness.ListCrossAccountAuthorizationsOutput, error)
+ ListCrossAccountAuthorizationsRequest(*route53recoveryreadiness.ListCrossAccountAuthorizationsInput) (*request.Request, *route53recoveryreadiness.ListCrossAccountAuthorizationsOutput)
+
+ ListCrossAccountAuthorizationsPages(*route53recoveryreadiness.ListCrossAccountAuthorizationsInput, func(*route53recoveryreadiness.ListCrossAccountAuthorizationsOutput, bool) bool) error
+ ListCrossAccountAuthorizationsPagesWithContext(aws.Context, *route53recoveryreadiness.ListCrossAccountAuthorizationsInput, func(*route53recoveryreadiness.ListCrossAccountAuthorizationsOutput, bool) bool, ...request.Option) error
+
+ ListReadinessChecks(*route53recoveryreadiness.ListReadinessChecksInput) (*route53recoveryreadiness.ListReadinessChecksOutput, error)
+ ListReadinessChecksWithContext(aws.Context, *route53recoveryreadiness.ListReadinessChecksInput, ...request.Option) (*route53recoveryreadiness.ListReadinessChecksOutput, error)
+ ListReadinessChecksRequest(*route53recoveryreadiness.ListReadinessChecksInput) (*request.Request, *route53recoveryreadiness.ListReadinessChecksOutput)
+
+ ListReadinessChecksPages(*route53recoveryreadiness.ListReadinessChecksInput, func(*route53recoveryreadiness.ListReadinessChecksOutput, bool) bool) error
+ ListReadinessChecksPagesWithContext(aws.Context, *route53recoveryreadiness.ListReadinessChecksInput, func(*route53recoveryreadiness.ListReadinessChecksOutput, bool) bool, ...request.Option) error
+
+ ListRecoveryGroups(*route53recoveryreadiness.ListRecoveryGroupsInput) (*route53recoveryreadiness.ListRecoveryGroupsOutput, error)
+ ListRecoveryGroupsWithContext(aws.Context, *route53recoveryreadiness.ListRecoveryGroupsInput, ...request.Option) (*route53recoveryreadiness.ListRecoveryGroupsOutput, error)
+ ListRecoveryGroupsRequest(*route53recoveryreadiness.ListRecoveryGroupsInput) (*request.Request, *route53recoveryreadiness.ListRecoveryGroupsOutput)
+
+ ListRecoveryGroupsPages(*route53recoveryreadiness.ListRecoveryGroupsInput, func(*route53recoveryreadiness.ListRecoveryGroupsOutput, bool) bool) error
+ ListRecoveryGroupsPagesWithContext(aws.Context, *route53recoveryreadiness.ListRecoveryGroupsInput, func(*route53recoveryreadiness.ListRecoveryGroupsOutput, bool) bool, ...request.Option) error
+
+ ListResourceSets(*route53recoveryreadiness.ListResourceSetsInput) (*route53recoveryreadiness.ListResourceSetsOutput, error)
+ ListResourceSetsWithContext(aws.Context, *route53recoveryreadiness.ListResourceSetsInput, ...request.Option) (*route53recoveryreadiness.ListResourceSetsOutput, error)
+ ListResourceSetsRequest(*route53recoveryreadiness.ListResourceSetsInput) (*request.Request, *route53recoveryreadiness.ListResourceSetsOutput)
+
+ ListResourceSetsPages(*route53recoveryreadiness.ListResourceSetsInput, func(*route53recoveryreadiness.ListResourceSetsOutput, bool) bool) error
+ ListResourceSetsPagesWithContext(aws.Context, *route53recoveryreadiness.ListResourceSetsInput, func(*route53recoveryreadiness.ListResourceSetsOutput, bool) bool, ...request.Option) error
+
+ ListRules(*route53recoveryreadiness.ListRulesInput) (*route53recoveryreadiness.ListRulesOutput, error)
+ ListRulesWithContext(aws.Context, *route53recoveryreadiness.ListRulesInput, ...request.Option) (*route53recoveryreadiness.ListRulesOutput, error)
+ ListRulesRequest(*route53recoveryreadiness.ListRulesInput) (*request.Request, *route53recoveryreadiness.ListRulesOutput)
+
+ ListRulesPages(*route53recoveryreadiness.ListRulesInput, func(*route53recoveryreadiness.ListRulesOutput, bool) bool) error
+ ListRulesPagesWithContext(aws.Context, *route53recoveryreadiness.ListRulesInput, func(*route53recoveryreadiness.ListRulesOutput, bool) bool, ...request.Option) error
+
+ ListTagsForResources(*route53recoveryreadiness.ListTagsForResourcesInput) (*route53recoveryreadiness.ListTagsForResourcesOutput, error)
+ ListTagsForResourcesWithContext(aws.Context, *route53recoveryreadiness.ListTagsForResourcesInput, ...request.Option) (*route53recoveryreadiness.ListTagsForResourcesOutput, error)
+ ListTagsForResourcesRequest(*route53recoveryreadiness.ListTagsForResourcesInput) (*request.Request, *route53recoveryreadiness.ListTagsForResourcesOutput)
+
+ TagResource(*route53recoveryreadiness.TagResourceInput) (*route53recoveryreadiness.TagResourceOutput, error)
+ TagResourceWithContext(aws.Context, *route53recoveryreadiness.TagResourceInput, ...request.Option) (*route53recoveryreadiness.TagResourceOutput, error)
+ TagResourceRequest(*route53recoveryreadiness.TagResourceInput) (*request.Request, *route53recoveryreadiness.TagResourceOutput)
+
+ UntagResource(*route53recoveryreadiness.UntagResourceInput) (*route53recoveryreadiness.UntagResourceOutput, error)
+ UntagResourceWithContext(aws.Context, *route53recoveryreadiness.UntagResourceInput, ...request.Option) (*route53recoveryreadiness.UntagResourceOutput, error)
+ UntagResourceRequest(*route53recoveryreadiness.UntagResourceInput) (*request.Request, *route53recoveryreadiness.UntagResourceOutput)
+
+ UpdateCell(*route53recoveryreadiness.UpdateCellInput) (*route53recoveryreadiness.UpdateCellOutput, error)
+ UpdateCellWithContext(aws.Context, *route53recoveryreadiness.UpdateCellInput, ...request.Option) (*route53recoveryreadiness.UpdateCellOutput, error)
+ UpdateCellRequest(*route53recoveryreadiness.UpdateCellInput) (*request.Request, *route53recoveryreadiness.UpdateCellOutput)
+
+ UpdateReadinessCheck(*route53recoveryreadiness.UpdateReadinessCheckInput) (*route53recoveryreadiness.UpdateReadinessCheckOutput, error)
+ UpdateReadinessCheckWithContext(aws.Context, *route53recoveryreadiness.UpdateReadinessCheckInput, ...request.Option) (*route53recoveryreadiness.UpdateReadinessCheckOutput, error)
+ UpdateReadinessCheckRequest(*route53recoveryreadiness.UpdateReadinessCheckInput) (*request.Request, *route53recoveryreadiness.UpdateReadinessCheckOutput)
+
+ UpdateRecoveryGroup(*route53recoveryreadiness.UpdateRecoveryGroupInput) (*route53recoveryreadiness.UpdateRecoveryGroupOutput, error)
+ UpdateRecoveryGroupWithContext(aws.Context, *route53recoveryreadiness.UpdateRecoveryGroupInput, ...request.Option) (*route53recoveryreadiness.UpdateRecoveryGroupOutput, error)
+ UpdateRecoveryGroupRequest(*route53recoveryreadiness.UpdateRecoveryGroupInput) (*request.Request, *route53recoveryreadiness.UpdateRecoveryGroupOutput)
+
+ UpdateResourceSet(*route53recoveryreadiness.UpdateResourceSetInput) (*route53recoveryreadiness.UpdateResourceSetOutput, error)
+ UpdateResourceSetWithContext(aws.Context, *route53recoveryreadiness.UpdateResourceSetInput, ...request.Option) (*route53recoveryreadiness.UpdateResourceSetOutput, error)
+ UpdateResourceSetRequest(*route53recoveryreadiness.UpdateResourceSetInput) (*request.Request, *route53recoveryreadiness.UpdateResourceSetOutput)
+}
+
+var _ Route53RecoveryReadinessAPI = (*route53recoveryreadiness.Route53RecoveryReadiness)(nil)
diff --git a/service/route53recoveryreadiness/service.go b/service/route53recoveryreadiness/service.go
new file mode 100644
index 0000000000..b295957944
--- /dev/null
+++ b/service/route53recoveryreadiness/service.go
@@ -0,0 +1,104 @@
+// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
+
+package route53recoveryreadiness
+
+import (
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/client"
+ "github.com/aws/aws-sdk-go/aws/client/metadata"
+ "github.com/aws/aws-sdk-go/aws/request"
+ "github.com/aws/aws-sdk-go/aws/signer/v4"
+ "github.com/aws/aws-sdk-go/private/protocol"
+ "github.com/aws/aws-sdk-go/private/protocol/restjson"
+)
+
+// Route53RecoveryReadiness provides the API operation methods for making requests to
+// AWS Route53 Recovery Readiness. See this package's package overview docs
+// for details on the service.
+//
+// Route53RecoveryReadiness methods are safe to use concurrently. It is not safe to
+// modify mutate any of the struct's properties though.
+type Route53RecoveryReadiness struct {
+ *client.Client
+}
+
+// Used for custom client initialization logic
+var initClient func(*client.Client)
+
+// Used for custom request initialization logic
+var initRequest func(*request.Request)
+
+// Service information constants
+const (
+ ServiceName = "Route53 Recovery Readiness" // Name of service.
+ EndpointsID = "route53-recovery-readiness" // ID to lookup a service endpoint with.
+ ServiceID = "Route53 Recovery Readiness" // ServiceID is a unique identifier of a specific service.
+)
+
+// New creates a new instance of the Route53RecoveryReadiness client with a session.
+// If additional configuration is needed for the client instance use the optional
+// aws.Config parameter to add your extra config.
+//
+// Example:
+// mySession := session.Must(session.NewSession())
+//
+// // Create a Route53RecoveryReadiness client from just a session.
+// svc := route53recoveryreadiness.New(mySession)
+//
+// // Create a Route53RecoveryReadiness client with additional configuration
+// svc := route53recoveryreadiness.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
+func New(p client.ConfigProvider, cfgs ...*aws.Config) *Route53RecoveryReadiness {
+ c := p.ClientConfig(EndpointsID, cfgs...)
+ if c.SigningNameDerived || len(c.SigningName) == 0 {
+ c.SigningName = "route53-recovery-readiness"
+ }
+ return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName)
+}
+
+// newClient creates, initializes and returns a new service client instance.
+func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *Route53RecoveryReadiness {
+ svc := &Route53RecoveryReadiness{
+ Client: client.New(
+ cfg,
+ metadata.ClientInfo{
+ ServiceName: ServiceName,
+ ServiceID: ServiceID,
+ SigningName: signingName,
+ SigningRegion: signingRegion,
+ PartitionID: partitionID,
+ Endpoint: endpoint,
+ APIVersion: "2019-12-02",
+ },
+ handlers,
+ ),
+ }
+
+ // Handlers
+ svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler)
+ svc.Handlers.Build.PushBackNamed(restjson.BuildHandler)
+ svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler)
+ svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler)
+ svc.Handlers.UnmarshalError.PushBackNamed(
+ protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(),
+ )
+
+ // Run custom client initialization if present
+ if initClient != nil {
+ initClient(svc.Client)
+ }
+
+ return svc
+}
+
+// newRequest creates a new request for a Route53RecoveryReadiness operation and runs any
+// custom request initialization.
+func (c *Route53RecoveryReadiness) newRequest(op *request.Operation, params, data interface{}) *request.Request {
+ req := c.NewRequest(op, params, data)
+
+ // Run custom request initialization if present
+ if initRequest != nil {
+ initRequest(req)
+ }
+
+ return req
+}
diff --git a/service/shield/api.go b/service/shield/api.go
index 2a183571ae..8fec68d9d9 100644
--- a/service/shield/api.go
+++ b/service/shield/api.go
@@ -58,11 +58,12 @@ func (c *Shield) AssociateDRTLogBucketRequest(input *AssociateDRTLogBucketInput)
// AssociateDRTLogBucket API operation for AWS Shield.
//
-// 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.
+// 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 DRT and make an AssociateDRTLogBucket request,
+// To use the services of the SRT and make an AssociateDRTLogBucket request,
// you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/)
// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).
//
@@ -93,10 +94,11 @@ func (c *Shield) AssociateDRTLogBucketRequest(input *AssociateDRTLogBucketInput)
// If available, this exception includes details in additional properties.
//
// * AccessDeniedForDependencyException
-// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
//
// * OptimisticLockException
// Exception that indicates that the resource state has been modified by another
@@ -173,10 +175,10 @@ func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *req
// AssociateDRTRole API operation for AWS Shield.
//
-// 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.
+// 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
@@ -189,16 +191,16 @@ func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *req
// The role must also trust the service principal drt.shield.amazonaws.com.
// For more information, see IAM JSON Policy Elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).
//
-// 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.
+// 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
-// AWS Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+// Amazon Web Services Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
//
-// To use the services of the DRT and make an AssociateDRTRole request, you
+// To use the services of the SRT and make an AssociateDRTRole request, you
// must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/)
// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).
//
@@ -223,10 +225,11 @@ func (c *Shield) AssociateDRTRoleRequest(input *AssociateDRTRoleInput) (req *req
// If available, this exception includes details in additional properties.
//
// * AccessDeniedForDependencyException
-// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
//
// * OptimisticLockException
// Exception that indicates that the resource state has been modified by another
@@ -304,13 +307,14 @@ func (c *Shield) AssociateHealthCheckRequest(input *AssociateHealthCheckInput) (
// AssociateHealthCheck API operation for AWS Shield.
//
// 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.
+// 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 (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option)
-// in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).
+// in the WAF Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -406,8 +410,8 @@ func (c *Shield) AssociateProactiveEngagementDetailsRequest(input *AssociateProa
// AssociateProactiveEngagementDetails API operation for AWS Shield.
//
-// 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
+// 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
@@ -415,8 +419,8 @@ func (c *Shield) AssociateProactiveEngagementDetailsRequest(input *AssociateProa
// 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.
+// 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,
@@ -517,16 +521,17 @@ func (c *Shield) CreateProtectionRequest(input *CreateProtectionInput) (req *req
// CreateProtection API operation for AWS Shield.
//
-// 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.
+// 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 AWS WAF console (https://console.aws.amazon.com/waf/). For more information
-// see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html)
-// and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).
+// the WAF console (https://console.aws.amazon.com/waf/). For more information
+// see Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html)
+// and Add Shield Advanced Protection to more Amazon Web Services Resources
+// (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -736,7 +741,7 @@ func (c *Shield) CreateSubscriptionRequest(input *CreateSubscriptionInput) (req
// CreateSubscription API operation for AWS Shield.
//
-// Activates AWS Shield Advanced for an account.
+// 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
@@ -825,7 +830,7 @@ func (c *Shield) DeleteProtectionRequest(input *DeleteProtectionInput) (req *req
// DeleteProtection API operation for AWS Shield.
//
-// Deletes an AWS Shield Advanced Protection.
+// Deletes an Shield Advanced Protection.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1008,9 +1013,9 @@ func (c *Shield) DeleteSubscriptionRequest(input *DeleteSubscriptionInput) (req
// DeleteSubscription API operation for AWS Shield.
//
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1188,10 +1193,10 @@ func (c *Shield) DescribeAttackStatisticsRequest(input *DescribeAttackStatistics
// DescribeAttackStatistics API operation for AWS Shield.
//
-// 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.
+// 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
@@ -1279,9 +1284,9 @@ func (c *Shield) DescribeDRTAccessRequest(input *DescribeDRTAccessInput) (req *r
// DescribeDRTAccess API operation for AWS Shield.
//
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1365,9 +1370,9 @@ func (c *Shield) DescribeEmergencyContactSettingsRequest(input *DescribeEmergenc
// DescribeEmergencyContactSettings API operation for AWS Shield.
//
-// 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.
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1623,7 +1628,7 @@ func (c *Shield) DescribeSubscriptionRequest(input *DescribeSubscriptionInput) (
// DescribeSubscription API operation for AWS Shield.
//
-// Provides details about the AWS Shield Advanced subscription for an account.
+// Provides details about the Shield Advanced subscription for an account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1708,8 +1713,8 @@ func (c *Shield) DisableProactiveEngagementRequest(input *DisableProactiveEngage
// DisableProactiveEngagement API operation for AWS Shield.
//
-// Removes authorization from the DDoS Response Team (DRT) to notify contacts
-// about escalations to the DRT and to initiate proactive customer support.
+// Removes authorization from the Shield Response Team (SRT) to notify contacts
+// about escalations to the SRT and to initiate proactive customer support.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1806,14 +1811,14 @@ func (c *Shield) DisassociateDRTLogBucketRequest(input *DisassociateDRTLogBucket
// DisassociateDRTLogBucket API operation for AWS Shield.
//
-// Removes the DDoS Response Team's (DRT) access to the specified Amazon S3
-// bucket containing your AWS WAF logs.
+// 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 (https://aws.amazon.com/premiumsupport/business-support/)
// or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).
// 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
+// been previously and had granted the SRT access to your account, you can submit
// a DisassociateDRTLogBucket request to remove this access.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -1836,10 +1841,11 @@ func (c *Shield) DisassociateDRTLogBucketRequest(input *DisassociateDRTLogBucket
// The ARN of the role that you specifed does not exist.
//
// * AccessDeniedForDependencyException
-// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
//
// * OptimisticLockException
// Exception that indicates that the resource state has been modified by another
@@ -1916,13 +1922,14 @@ func (c *Shield) DisassociateDRTRoleRequest(input *DisassociateDRTRoleInput) (re
// DisassociateDRTRole API operation for AWS Shield.
//
-// Removes the DDoS Response Team's (DRT) access to your AWS account.
+// 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 (https://aws.amazon.com/premiumsupport/business-support/) or
// the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).
// 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
+// been previously and had granted the SRT access to your account, you can submit
// a DisassociateDRTRole request to remove this access.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -2018,13 +2025,13 @@ func (c *Shield) DisassociateHealthCheckRequest(input *DisassociateHealthCheckIn
//
// 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.
+// 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 (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option)
-// in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).
+// in the WAF Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2117,8 +2124,8 @@ func (c *Shield) EnableProactiveEngagementRequest(input *EnableProactiveEngageme
// EnableProactiveEngagement API operation for AWS Shield.
//
-// Authorizes the DDoS Response Team (DRT) to use email and phone to notify
-// contacts about escalations to the DRT and to initiate proactive customer
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -2880,8 +2887,8 @@ func (c *Shield) ListTagsForResourceRequest(input *ListTagsForResourceInput) (re
// ListTagsForResource API operation for AWS Shield.
//
-// Gets information about AWS tags for a specified Amazon Resource Name (ARN)
-// in AWS Shield.
+// Gets information about Amazon Web Services tags for a specified Amazon Resource
+// Name (ARN) in Shield.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2970,7 +2977,7 @@ func (c *Shield) TagResourceRequest(input *TagResourceInput) (req *request.Reque
// TagResource API operation for AWS Shield.
//
-// Adds or updates tags for a resource in AWS Shield.
+// Adds or updates tags for a resource in Shield.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3063,7 +3070,7 @@ func (c *Shield) UntagResourceRequest(input *UntagResourceInput) (req *request.R
// UntagResource API operation for AWS Shield.
//
-// Removes tags from a resource in AWS Shield.
+// Removes tags from a resource in Shield.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3157,8 +3164,8 @@ func (c *Shield) UpdateEmergencyContactSettingsRequest(input *UpdateEmergencyCon
// UpdateEmergencyContactSettings API operation for AWS Shield.
//
// 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
+// 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.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -3459,10 +3466,11 @@ func (s *AccessDeniedException) RequestID() string {
return s.RespMetadata.RequestID
}
-// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+// 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
type AccessDeniedForDependencyException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -3521,7 +3529,7 @@ func (s *AccessDeniedForDependencyException) RequestID() string {
type AssociateDRTLogBucketInput struct {
_ struct{} `type:"structure"`
- // The Amazon S3 bucket that contains your AWS WAF logs.
+ // The Amazon S3 bucket that contains the logs that you want to share.
//
// LogBucket is a required field
LogBucket *string `min:"3" type:"string" required:"true"`
@@ -3576,8 +3584,8 @@ func (s AssociateDRTLogBucketOutput) GoString() string {
type AssociateDRTRoleInput struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of the role the DRT will use to access your
- // AWS account.
+ // 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
// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy)
@@ -3711,8 +3719,8 @@ func (s AssociateHealthCheckOutput) GoString() string {
type AssociateProactiveEngagementDetailsInput struct {
_ struct{} `type:"structure"`
- // 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
+ // 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
@@ -3789,7 +3797,12 @@ type AttackDetail struct {
// The unique identifier (ID) of the attack.
AttackId *string `min:"1" type:"string"`
- // The array of AttackProperty objects.
+ // 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 (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms)
+ // in the WAF Developer Guide.
AttackProperties []*AttackProperty `type:"list"`
// The time the attack ended, in Unix time in seconds. For more information
@@ -3869,29 +3882,31 @@ func (s *AttackDetail) SetSubResources(v []*SubResourceSummary) *AttackDetail {
return s
}
-// Details of the described attack.
+// Details of a Shield event. This is provided as part of an AttackDetail.
type AttackProperty struct {
_ struct{} `type:"structure"`
- // 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 (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms)
+ // in the WAF Developer Guide.
AttackLayer *string `type:"string" enum:"AttackLayer"`
- // Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR
+ // 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 DDoS attacks.
+ // pingback events.
AttackPropertyIdentifier *string `type:"string" enum:"AttackPropertyIdentifier"`
- // The array of contributor objects that includes the top five contributors
- // to an attack.
+ // Contributor objects for the top five contributors to a Shield event.
TopContributors []*Contributor `type:"list"`
- // 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.
Total *int64 `type:"long"`
- // The unit of the Value of the contributions.
+ // The unit used for the Contributor Value property.
Unit *string `type:"string" enum:"Unit"`
}
@@ -4211,7 +4226,7 @@ func (s *Contributor) SetValue(v int64) *Contributor {
type CreateProtectionGroupInput struct {
_ struct{} `type:"structure"`
- // Defines how AWS Shield combines resource data for the group in order to detect,
+ // 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
@@ -4224,8 +4239,8 @@ type CreateProtectionGroupInput struct {
//
// * 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.
+ // in a non-uniform way. Examples include Amazon CloudFront and origin resources
+ // for CloudFront distributions.
//
// Aggregation is a required field
Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`
@@ -4369,9 +4384,9 @@ type CreateProtectionInput struct {
//
// * 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 Amazon 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 an Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
//
// * For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
//
@@ -4768,11 +4783,11 @@ func (s DescribeDRTAccessInput) GoString() string {
type DescribeDRTAccessOutput struct {
_ struct{} `type:"structure"`
- // The list of Amazon S3 buckets accessed by the DRT.
+ // The list of Amazon S3 buckets accessed by the SRT.
LogBucketList []*string `type:"list"`
- // The Amazon Resource Name (ARN) of the role the DRT used to access your AWS
- // account.
+ // The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon
+ // Web Services account.
RoleArn *string `min:"1" type:"string"`
}
@@ -4815,9 +4830,9 @@ func (s DescribeEmergencyContactSettingsInput) GoString() string {
type DescribeEmergencyContactSettingsOutput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
EmergencyContactList []*EmergencyContact `type:"list"`
}
@@ -4883,7 +4898,7 @@ func (s *DescribeProtectionGroupInput) SetProtectionGroupId(v string) *DescribeP
type DescribeProtectionGroupOutput struct {
_ struct{} `type:"structure"`
- // A grouping of protected resources that you and AWS Shield Advanced can monitor
+ // 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.
//
@@ -4915,9 +4930,10 @@ type DescribeProtectionInput struct {
// or the ProtectionID, but not both.
ProtectionId *string `min:"1" type:"string"`
- // 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.
ResourceArn *string `min:"1" type:"string"`
}
@@ -4999,7 +5015,7 @@ func (s DescribeSubscriptionInput) GoString() string {
type DescribeSubscriptionOutput struct {
_ struct{} `type:"structure"`
- // The AWS Shield Advanced subscription details for an account.
+ // The Shield Advanced subscription details for an account.
Subscription *Subscription `type:"structure"`
}
@@ -5050,7 +5066,7 @@ func (s DisableProactiveEngagementOutput) GoString() string {
type DisassociateDRTLogBucketInput struct {
_ struct{} `type:"structure"`
- // The Amazon S3 bucket that contains your AWS WAF logs.
+ // The Amazon S3 bucket that contains the logs that you want to share.
//
// LogBucket is a required field
LogBucket *string `min:"3" type:"string" required:"true"`
@@ -5204,8 +5220,8 @@ func (s DisassociateHealthCheckOutput) GoString() string {
return s.String()
}
-// 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
+// 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.
type EmergencyContact struct {
_ struct{} `type:"structure"`
@@ -5908,8 +5924,8 @@ type ListProtectionGroupsOutput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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.
NextToken *string `min:"1" type:"string"`
// ProtectionGroups is a required field
@@ -5995,10 +6011,10 @@ type ListProtectionsOutput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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
@@ -6107,9 +6123,8 @@ type ListResourcesInProtectionGroupOutput struct {
_ struct{} `type:"structure"`
// 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.
+ // 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.
NextToken *string `min:"1" type:"string"`
// The Amazon Resource Names (ARNs) of the resources that are included in the
@@ -6418,7 +6433,8 @@ type Protection struct {
// The ARN (Amazon Resource Name) of the protection.
ProtectionArn *string `min:"1" type:"string"`
- // The ARN (Amazon Resource Name) of the AWS resource that is protected.
+ // The ARN (Amazon Resource Name) of the Amazon Web Services resource that is
+ // protected.
ResourceArn *string `min:"1" type:"string"`
}
@@ -6462,13 +6478,13 @@ func (s *Protection) SetResourceArn(v string) *Protection {
return s
}
-// A grouping of protected resources that you and AWS Shield Advanced can monitor
+// 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.
type ProtectionGroup struct {
_ struct{} `type:"structure"`
- // Defines how AWS Shield combines resource data for the group in order to detect,
+ // 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
@@ -6481,8 +6497,8 @@ type ProtectionGroup struct {
//
// * 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.
+ // in a non-uniform way. Examples include Amazon CloudFront distributions
+ // and origin resources for CloudFront distributions.
//
// Aggregation is a required field
Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`
@@ -6852,7 +6868,7 @@ func (s *SubResourceSummary) SetType(v string) *SubResourceSummary {
return s
}
-// Information about the AWS Shield Advanced subscription for an account.
+// Information about the Shield Advanced subscription for an account.
type Subscription struct {
_ struct{} `type:"structure"`
@@ -6871,14 +6887,14 @@ type Subscription struct {
// Specifies how many protections of a given type you can create.
Limits []*Limit `type:"list"`
- // 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
+ // 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 DRT will not proactively notify contacts about escalations
+ // If DISABLED, the SRT will not proactively notify contacts about escalations
// or to initiate proactive customer support.
ProactiveEngagementStatus *string `type:"string" enum:"ProactiveEngagementStatus"`
@@ -6894,7 +6910,7 @@ type Subscription struct {
// SubscriptionLimits is a required field
SubscriptionLimits *SubscriptionLimits `type:"structure" required:"true"`
- // The length, in seconds, of the AWS Shield Advanced subscription for the account.
+ // The length, in seconds, of the Shield Advanced subscription for the account.
TimeCommitmentInSeconds *int64 `type:"long"`
}
@@ -7097,14 +7113,14 @@ func (s *SummarizedCounter) SetUnit(v string) *SummarizedCounter {
return s
}
-// 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.
+// 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.
type Tag struct {
_ struct{} `type:"structure"`
@@ -7341,9 +7357,9 @@ func (s UntagResourceOutput) GoString() string {
type UpdateEmergencyContactSettingsInput struct {
_ struct{} `type:"structure"`
- // 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.
+ // 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.
@@ -7403,7 +7419,7 @@ func (s UpdateEmergencyContactSettingsOutput) GoString() string {
type UpdateProtectionGroupInput struct {
_ struct{} `type:"structure"`
- // Defines how AWS Shield combines resource data for the group in order to detect,
+ // 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
@@ -7416,8 +7432,8 @@ type UpdateProtectionGroupInput struct {
//
// * 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.
+ // in a non-uniform way. Examples include Amazon CloudFront distributions
+ // and origin resources for CloudFront distributions.
//
// Aggregation is a required field
Aggregation *string `type:"string" required:"true" enum:"ProtectionGroupAggregation"`
diff --git a/service/shield/doc.go b/service/shield/doc.go
index e663cfb2ea..53a8436450 100644
--- a/service/shield/doc.go
+++ b/service/shield/doc.go
@@ -3,11 +3,11 @@
// Package shield provides the client and types for making API
// requests to AWS Shield.
//
-// 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).
+// 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 (https://docs.aws.amazon.com/waf/latest/developerguide/).
//
// See https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02 for more information on this service.
//
diff --git a/service/shield/errors.go b/service/shield/errors.go
index 53a2eba21a..ca8e544aad 100644
--- a/service/shield/errors.go
+++ b/service/shield/errors.go
@@ -18,10 +18,11 @@ const (
// ErrCodeAccessDeniedForDependencyException for service response error code
// "AccessDeniedForDependencyException".
//
- // 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
+ // 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).
ErrCodeAccessDeniedForDependencyException = "AccessDeniedForDependencyException"
// ErrCodeInternalErrorException for service response error code