The key in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"ec2:ResourceTag/Department\" is the key.
The key in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"ec2:ResourceTag/Department\" is the key.
The value in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"accounting\" is the value.
The value in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"accounting\" is the value.
An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
" + "BackupSelection$Resources": "An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
", + "BackupSelection$NotResources": null } }, "ResourceNotFoundException": { diff --git a/models/apis/ecs/2014-11-13/api-2.json b/models/apis/ecs/2014-11-13/api-2.json index f3baabee74b..1776a340325 100644 --- a/models/apis/ecs/2014-11-13/api-2.json +++ b/models/apis/ecs/2014-11-13/api-2.json @@ -1238,17 +1238,28 @@ "attributes":{"shape":"Attributes"}, "registeredAt":{"shape":"Timestamp"}, "attachments":{"shape":"Attachments"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "healthStatus":{"shape":"ContainerInstanceHealthStatus"} } }, "ContainerInstanceField":{ "type":"string", - "enum":["TAGS"] + "enum":[ + "TAGS", + "CONTAINER_INSTANCE_HEALTH" + ] }, "ContainerInstanceFieldList":{ "type":"list", "member":{"shape":"ContainerInstanceField"} }, + "ContainerInstanceHealthStatus":{ + "type":"structure", + "members":{ + "overallStatus":{"shape":"InstanceHealthCheckState"}, + "details":{"shape":"InstanceHealthCheckResultList"} + } + }, "ContainerInstanceStatus":{ "type":"string", "enum":[ @@ -1999,6 +2010,32 @@ "type":"list", "member":{"shape":"InferenceAccelerator"} }, + "InstanceHealthCheckResult":{ + "type":"structure", + "members":{ + "type":{"shape":"InstanceHealthCheckType"}, + "status":{"shape":"InstanceHealthCheckState"}, + "lastUpdated":{"shape":"Timestamp"}, + "lastStatusChange":{"shape":"Timestamp"} + } + }, + "InstanceHealthCheckResultList":{ + "type":"list", + "member":{"shape":"InstanceHealthCheckResult"} + }, + "InstanceHealthCheckState":{ + "type":"string", + "enum":[ + "OK", + "IMPAIRED", + "INSUFFICIENT_DATA", + "INITIALIZING" + ] + }, + "InstanceHealthCheckType":{ + "type":"string", + "enum":["CONTAINER_RUNTIME"] + }, "Integer":{"type":"integer"}, "InvalidParameterException":{ "type":"structure", diff --git a/models/apis/ecs/2014-11-13/docs-2.json b/models/apis/ecs/2014-11-13/docs-2.json index 16f3db4dbb0..7666a3cf6dc 100644 --- a/models/apis/ecs/2014-11-13/docs-2.json +++ b/models/apis/ecs/2014-11-13/docs-2.json @@ -1,19 +1,19 @@ { "version": "2.0", - "service": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
", + "service": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
", "operations": { - "CreateCapacityProvider": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by Fargate.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other Amazon Web Services services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the IAM user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support the task definition of your service. For example, they have the required CPU, memory, ports, and container instance attributes.
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner. This is the case even if you can choose a different placement strategy with the placementStrategy parameter.
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone based on the previous steps, favoring container instances with the fewest number of running tasks for this service.
Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
", "DeleteAttributes": "Deletes one or more custom attributes from an Amazon ECS resource.
", - "DeleteCapacityProvider": "Deletes the specified capacity provider.
The FARGATE and FARGATE_SPOT capacity providers are reserved and cannot be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that are not associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
Deletes the specified cluster. The cluster will transition to the INACTIVE state. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", - "DeleteService": "Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
Deletes the specified capacity provider.
The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", + "DeleteService": "Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You can't use an INACTIVE task definition to run new tasks or create new services, and you can't update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
Describes one or more of your capacity providers.
", "DescribeClusters": "Describes one or more of your clusters.
", "DescribeContainerInstances": "Describes one or more container instances. Returns metadata about each container instance requested.
", @@ -24,47 +24,47 @@ "DiscoverPollEndpoint": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
", "ExecuteCommand": "Runs a command remotely on a container within a task.
", "ListAccountSettings": "Lists the account settings for a specified principal.
", - "ListAttributes": "Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
Returns a list of existing clusters.
", "ListContainerInstances": "Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
", "ListTagsForResource": "List the tags for an Amazon ECS resource.
", - "ListTaskDefinitionFamilies": "Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.
You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
", - "PutAccountSetting": "Modifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
", - "PutAttributes": "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", - "PutClusterCapacityProviders": "Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([]) to bypass defining a default strategy.
Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", + "PutClusterCapacityProviders": "Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
", - "RegisterTaskDefinition": "Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the IAM policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model. This is because the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
", "StopTask": "Stops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
", "SubmitContainerStateChange": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
", "SubmitTaskStateChange": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
", - "TagResource": "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
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.
Deletes specified tags from a resource.
", "UpdateCapacityProvider": "Modifies the parameters for a capacity provider.
", "UpdateCluster": "Updates the cluster.
", "UpdateClusterSettings": "Modifies the settings to use for a cluster.
", - "UpdateContainerAgent": "Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package which will update the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance cannot be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment should be created. For more information, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and the container instance they're hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment is created. For more information, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set. For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and the container instance they're hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.
Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
You do not have authorization to perform the requested action.
", + "base": "You don't have authorization to perform the requested action.
", "refs": { } }, "AgentUpdateStatus": { "base": null, "refs": { - "ContainerInstance$agentUpdateStatus": "The status of the most recent agent update. If an update has never been requested, this value is NULL.
The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
", + "Cluster$attachments": "The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that's created is returned as a cluster attachment.
", "ContainerInstance$attachments": "The resources attached to a container instance, such as elastic network interfaces.
", - "Task$attachments": "The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", + "base": "An attribute is a name-value pair that's associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
", "refs": { "Attributes$member": null, "RequiresAttributes$member": null } }, "AttributeLimitExceededException": { - "base": "You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
", + "base": "You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
", "refs": { } }, @@ -122,10 +122,10 @@ "base": null, "refs": { "ContainerInstance$attributes": "The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
", - "DeleteAttributesRequest$attributes": "The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
", + "DeleteAttributesRequest$attributes": "The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.
", "DeleteAttributesResponse$attributes": "A list of attribute objects that were successfully deleted from your resource.
", "ListAttributesResponse$attributes": "A list of attribute objects that meet the criteria of the request.
", - "PutAttributesRequest$attributes": "The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
", + "PutAttributesRequest$attributes": "The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.
", "PutAttributesResponse$attributes": "The attributes applied to your resource.
", "RegisterContainerInstanceRequest$attributes": "The container instance attributes that this container instance supports.
", "Task$attributes": "The attributes of the task
" @@ -141,17 +141,17 @@ "AutoScalingGroupProviderUpdate": { "base": "The details of the Auto Scaling group capacity provider to update.
", "refs": { - "UpdateCapacityProviderRequest$autoScalingGroupProvider": "An object representing the parameters to update for the Auto Scaling group capacity provider.
" + "UpdateCapacityProviderRequest$autoScalingGroupProvider": "An object that represent the parameters to update for the Auto Scaling group capacity provider.
" } }, "AwsVpcConfiguration": { "base": "An object representing the networking details for a task or service.
", "refs": { - "NetworkConfiguration$awsvpcConfiguration": "The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
The VPC subnets and security groups that are associated with a task.
All specified subnets and security groups must be from the same VPC.
Your Amazon Web Services account has been blocked. For more information, contact Amazon Web Services Support.
", + "base": "Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.
", "refs": { } }, @@ -160,37 +160,37 @@ "refs": { "ContainerInstance$agentConnected": "This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", - "CreateServiceRequest$enableExecuteCommand": "Whether or not the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.
Whether to enable the deployment circuit breaker logic for the service.
", - "DeploymentCircuitBreaker$rollback": "Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
", - "ExecuteCommandLogConfiguration$cloudWatchEncryptionEnabled": "Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
", - "ExecuteCommandLogConfiguration$s3EncryptionEnabled": "Whether or not to use encryption on the S3 logs. If not specified, encryption is not used.
", + "CreateServiceRequest$enableExecuteCommand": "Determines whether the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.
Determines whether to enable the deployment circuit breaker logic for the service.
", + "DeploymentCircuitBreaker$rollback": "Determines whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
", + "ExecuteCommandLogConfiguration$cloudWatchEncryptionEnabled": "Determines whether to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
", + "ExecuteCommandLogConfiguration$s3EncryptionEnabled": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
", "ExecuteCommandRequest$interactive": "Use this flag to run your command in interactive mode.
", - "ExecuteCommandResponse$interactive": "Whether or not the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.
Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.
Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.
Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", - "RunTaskRequest$enableExecuteCommand": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", - "Service$enableExecuteCommand": "Whether or not the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.
Determines whether to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Determines whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "Service$enableExecuteCommand": "Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", "StartTaskRequest$enableExecuteCommand": "Whether or not the execute command functionality is enabled for the task. If true, this enables execute command functionality on all containers in the task.
Whether or not execute command functionality is enabled for this task. If true, this enables execute command functionality on all containers in the task.
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.
Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
", + "ContainerDefinition$essential": "If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
", "ContainerDefinition$disableNetworking": "When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges 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.
This parameter is not supported for Windows containers or tasks run on Fargate.
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.
This parameter is not supported for Windows containers.
When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.
When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.
If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.
If true, this allows you to delete a task set even if it hasn't been scaled down to zero.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
", - "DockerVolumeConfiguration$autoprovision": "If this value is true, the Docker volume is created if it does not already exist.
This field is only used if the scope is shared.
If true, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.
If true, you can delete a task set even if it hasn't been scaled down to zero.
Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
", + "DockerVolumeConfiguration$autoprovision": "If this value is true, the Docker volume is created if it doesn't already exist.
This field is only used if the scope is shared.
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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
If true, this enables execute command functionality on all task containers.
If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.
The exit code returned from the container.
", - "ContainerDefinition$memory": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
", - "ContainerDefinition$memoryReservation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
", - "ContainerDefinition$startTimeout": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it is enforced indendently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the followiwng platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the followiwng platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers.
", + "ContainerDefinition$memoryReservation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers.
", + "ContainerDefinition$startTimeout": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
", "ContainerOverride$memoryReservation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
", "ContainerStateChange$exitCode": "The exit code for the container, if the state change is a result of the container exiting.
", - "CreateServiceRequest$desiredCount": "The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
", + "CreateServiceRequest$desiredCount": "The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
", "DeploymentConfiguration$maximumPercent": "If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
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.
", "HealthCheck$interval": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
", "HealthCheck$timeout": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
", "HealthCheck$retries": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
", - "HealthCheck$startPeriod": "The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is disabled.
If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will 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.
If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported.
The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.
The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters 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 ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances 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 ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices 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 ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
The port number on the container that is used with the network binding.
", - "NetworkBinding$hostPort": "The port number on the host that is used with the network binding.
", - "PortMapping$containerPort": "The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
", + "LinuxParameters$maxSwap": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will 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.
If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.
The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.
The maximum number of cluster results that ListClusters returned in paginated output. When this parameter is used, ListClusters 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 ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances 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 ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices 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 ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.
The maximum number of task definition family results that ListTaskDefinitionFamilies returned in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The maximum number of task definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.
The port number on the container that's used with the network binding.
", + "NetworkBinding$hostPort": "The port number on the host that's used with the network binding.
", + "PortMapping$containerPort": "The port number on the container that's bound to the user-specified or automatically assigned host port.
If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.
If you use containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
", "Service$healthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
", - "ServiceRegistry$port": "The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
The exit code returned for the state change request.
", + "ServiceRegistry$port": "The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.
The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.
The exit code that's returned for the state change request.
", "UpdateServiceRequest$desiredCount": "The number of instantiations of the task to place and keep running in your service.
", - "UpdateServiceRequest$healthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" + "UpdateServiceRequest$healthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" } }, "CPUArchitecture": { @@ -250,7 +250,7 @@ } }, "CapacityProvider": { - "base": "The details of a capacity provider.
", + "base": "The details for a capacity provider.
", "refs": { "CapacityProviders$member": null, "CreateCapacityProviderResponse$capacityProvider": "The full description of the new capacity provider.
", @@ -267,28 +267,28 @@ "CapacityProviderFieldList": { "base": null, "refs": { - "DescribeCapacityProvidersRequest$include": "Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it will have an INACTIVE status.
The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
", - "CreateClusterRequest$defaultCapacityProviderStrategy": "The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
", + "CreateClusterRequest$defaultCapacityProviderStrategy": "The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.
", "CreateServiceRequest$capacityProviderStrategy": "The capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
", "CreateTaskSetRequest$capacityProviderStrategy": "The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
", "Deployment$capacityProviderStrategy": "The capacity provider strategy that the deployment is using.
", "PutClusterCapacityProvidersRequest$defaultCapacityProviderStrategy": "The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
", - "Service$capacityProviderStrategy": "The capacity provider strategy the service is using. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
", - "TaskSet$capacityProviderStrategy": "The capacity provider strategy associated with the task set.
", - "UpdateServiceRequest$capacityProviderStrategy": "The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" + "Service$capacityProviderStrategy": "The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
", + "TaskSet$capacityProviderStrategy": "The capacity provider strategy that are associated with the task set.
", + "UpdateServiceRequest$capacityProviderStrategy": "The capacity provider strategy to update the service to use.
if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that's not the default capacity provider strategy, the service can't be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" } }, "CapacityProviderStrategyItem": { @@ -306,13 +306,13 @@ "CapacityProviderStrategyItemWeight": { "base": null, "refs": { - "CapacityProviderStrategyItem$weight": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 will not be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
The update status of the capacity provider. The following are the possible states that will be returned.
The capacity provider is in the process of being deleted.
The capacity provider has been successfully deleted and will have an INACTIVE status.
The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
The update status of the capacity provider. The following are the possible states that is returned.
The capacity provider is in the process of being deleted.
The capacity provider was successfully deleted and has an INACTIVE status.
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
", + "base": "These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.
", "refs": { } }, "Cluster": { - "base": "A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
", + "base": "A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
", "refs": { "Clusters$member": null, "CreateClusterResponse$cluster": "The full description of your new cluster.
", @@ -346,17 +346,17 @@ } }, "ClusterContainsContainerInstancesException": { - "base": "You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
", + "base": "You can't delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
", "refs": { } }, "ClusterContainsServicesException": { - "base": "You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
", + "base": "You can't delete a cluster that contains services. First, update the service to reduce its desired task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.
", "refs": { } }, "ClusterContainsTasksException": { - "base": "You cannot delete a cluster that has active tasks.
", + "base": "You can't delete a cluster that has active tasks.
", "refs": { } }, @@ -369,11 +369,11 @@ "ClusterFieldList": { "base": null, "refs": { - "DescribeClustersRequest$include": "Whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.
If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.
If SETTINGS is specified, the settings for the cluster are included.
If CONFIGURATIONS is specified, the configuration for the cluster is included.
If STATISTICS is specified, the task and service count is included, separated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are included.
Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.
If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.
If SETTINGS is specified, the settings for the cluster are included.
If CONFIGURATIONS is specified, the configuration for the cluster is included.
If STATISTICS is specified, the task and service count is included, separated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are included.
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
", + "base": "The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
", "refs": { } }, @@ -393,9 +393,9 @@ "base": null, "refs": { "Cluster$settings": "The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
", - "CreateClusterRequest$settings": "The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The cluster settings for your cluster.
", - "UpdateClusterSettingsRequest$settings": "The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
", + "RegisterTaskDefinitionRequest$requiresCompatibilities": "The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
", "TaskDefinition$compatibilities": "The task launch types the task definition validated against during task definition registration. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
", "TaskDefinition$requiresCompatibilities": "The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities parameter.
" } @@ -425,7 +425,7 @@ } }, "Container": { - "base": "A Docker container that is part of a task.
", + "base": "A Docker container that's part of a task.
", "refs": { "Containers$member": null } @@ -433,7 +433,7 @@ "ContainerCondition": { "base": null, "refs": { - "ContainerDependency$condition": "The dependency condition of the container. The following are the available conditions and their behavior:
START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container.
SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition cannot be set on an essential container.
HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
The dependency condition of the container. The following are the available conditions and their behavior:
START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.
SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.
HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the followiwng platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the followiwng platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
", + "base": "An EC2 instance that's running the Amazon ECS agent and has been registered with a cluster.
", "refs": { "ContainerInstances$member": null, "DeregisterContainerInstanceResponse$containerInstance": "The container instance that was deregistered.
", "RegisterContainerInstanceResponse$containerInstance": "The container instance that was registered.
", - "UpdateContainerAgentResponse$containerInstance": "The container instance for which the container agent was updated.
" + "UpdateContainerAgentResponse$containerInstance": "The container instance that the container agent was updated for.
" } }, "ContainerInstanceField": { @@ -479,14 +479,20 @@ "ContainerInstanceFieldList": { "base": null, "refs": { - "DescribeContainerInstancesRequest$include": "Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.
An object representing the health status of the container instance.
", + "refs": { + "ContainerInstance$healthStatus": "An object representing the health status of the container instance.
" } }, "ContainerInstanceStatus": { "base": null, "refs": { - "ListContainerInstancesRequest$status": "Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.
The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.
Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.
The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but can't update the container instance state.
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.
The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.
One or more container overrides sent to a task.
" + "TaskOverride$containerOverrides": "One or more container overrides that are sent to a task.
" } }, "ContainerStateChange": { - "base": "An object representing a change in state for a container.
", + "base": "An object that represents a change in state for a container.
", "refs": { "ContainerStateChanges$member": null } @@ -517,13 +523,13 @@ "ContainerStateChanges": { "base": null, "refs": { - "SubmitTaskStateChangeRequest$containers": "Any containers associated with the state change request.
" + "SubmitTaskStateChangeRequest$containers": "Any containers that's associated with the state change request.
" } }, "Containers": { "base": null, "refs": { - "Task$containers": "The containers associated with the task.
" + "Task$containers": "The containers that's associated with the task.
" } }, "CreateCapacityProviderRequest": { @@ -633,7 +639,7 @@ } }, "DeploymentCircuitBreaker": { - "base": "The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.
", + "base": "The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.
", "refs": { "DeploymentConfiguration$deploymentCircuitBreaker": "The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
" } @@ -650,7 +656,7 @@ "base": "The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
", "refs": { "CreateServiceRequest$deploymentController": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service uses the ECS deployment controller type.
The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.
The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).
The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).
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.
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
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.
If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
This parameter is specified when you are using Docker volumes.
Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.
Docker volumes are not supported by tasks run on Fargate.
This parameter is specified when you use Docker volumes.
Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
Whether or not to use the Amazon ECS task IAM role defined in a task 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 Amazon Elastic Container Service Developer Guide.
Determines whether to use the Amazon ECS task IAM role defined in a task 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 Amazon Elastic Container Service Developer Guide.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
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 Amazon Elastic Container Service Developer Guide.
", + "base": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
", "refs": { - "Volume$efsVolumeConfiguration": "This parameter is specified when you are using an Amazon Elastic File System file system for task storage.
" + "Volume$efsVolumeConfiguration": "This parameter is specified when you use an Amazon Elastic File System file system for task storage.
" } }, "EnvironmentFile": { - "base": "A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file contains an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
" } }, "EnvironmentVariables": { "base": null, "refs": { - "ContainerDefinition$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 do not recommend using plaintext environment variables for sensitive information, such as credential data.
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 that you use plaintext environment variables for sensitive information, such as credential data.
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 task definition. You must also specify a container name.
" } }, @@ -876,7 +882,7 @@ "RegisterTaskDefinitionRequest$ephemeralStorage": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The ephemeral storage settings for the task.
", "TaskDefinition$ephemeralStorage": "The ephemeral storage settings to use for tasks run with the task definition.
", - "TaskOverride$ephemeralStorage": "The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
Linux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
", + "base": "This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
", "refs": { - "Volume$fsxWindowsFileServerVolumeConfiguration": "This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
" + "Volume$fsxWindowsFileServerVolumeConfiguration": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
" } }, "Failure": { @@ -964,7 +970,7 @@ } }, "HealthCheck": { - "base": "An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a container:
HEALTHY-The container health check has passed successfully.
UNHEALTHY-The container health check has failed.
UNKNOWN-The container health check is being evaluated or there is no container health check defined.
The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
HEALTHY-All essential containers within the task have passed their health checks.
UNHEALTHY-One or more essential containers have failed their health check.
UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a container:
HEALTHY-The container health check has passed successfully.
UNHEALTHY-The container health check has failed.
UNKNOWN-The container health check is being evaluated or there's no container health check defined.
The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
HEALTHY-All essential containers within the task have passed their health checks.
UNHEALTHY-One or more essential containers have failed their health check.
UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see Fargate Platform Versions.
Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.
The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.
The health status for the task. It's determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as UNHEALTHY or UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in a container image and not specified in the container definition. For example, this includes those specified in a parent image or from the image's Dockerfile. Health check parameters that are specified in a container definition override any Docker health checks that are found in the container image.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.
Details on a container instance bind mount host volume.
", "refs": { - "Volume$host": "This parameter is specified when you are using bind mount host volumes. The contents of the host parameter determine whether your bind mount host 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 is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's 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 that are associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", + "base": "Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", "refs": { "InferenceAccelerators$member": null } @@ -1016,8 +1022,33 @@ "base": null, "refs": { "RegisterTaskDefinitionRequest$inferenceAccelerators": "The Elastic Inference accelerators to use for the containers in the task.
", - "Task$inferenceAccelerators": "The Elastic Inference accelerator associated with the task.
", - "TaskDefinition$inferenceAccelerators": "The Elastic Inference accelerator associated with the task.
" + "Task$inferenceAccelerators": "The Elastic Inference accelerator that's associated with the task.
", + "TaskDefinition$inferenceAccelerators": "The Elastic Inference accelerator that's associated with the task.
" + } + }, + "InstanceHealthCheckResult": { + "base": "An object representing the result of a container instance health status check.
", + "refs": { + "InstanceHealthCheckResultList$member": null + } + }, + "InstanceHealthCheckResultList": { + "base": null, + "refs": { + "ContainerInstanceHealthStatus$details": "An array of objects representing the details of the container instance health status.
" + } + }, + "InstanceHealthCheckState": { + "base": null, + "refs": { + "ContainerInstanceHealthStatus$overallStatus": "The overall health status of the container instance. This is an aggregate status of all container instance health checks.
", + "InstanceHealthCheckResult$status": "The container instance health status.
" + } + }, + "InstanceHealthCheckType": { + "base": null, + "refs": { + "InstanceHealthCheckResult$type": "The type of container instance health status that was verified.
" } }, "Integer": { @@ -1027,7 +1058,7 @@ "Cluster$runningTasksCount": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
The number of cpu units 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.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.
The number of cpu units 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.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one CPU.
The number of tasks on the container instance that are in the RUNNING status.
The number of tasks on the container instance that are in the PENDING status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
", @@ -1035,14 +1066,14 @@ "Deployment$runningCount": "The number of tasks in the deployment that are in the RUNNING status.
The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.
The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.
When the integerValue type is set, the value of the resource must be an integer.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
", "Service$runningCount": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one. This is even if you deregistered previous revisions in this family.
The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it's restarted after being in the STOPPED state.
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
The maximum size (in MiB) of the tmpfs volume.
", "Ulimit$softLimit": "The soft limit for the ulimit type.
", @@ -1050,7 +1081,7 @@ } }, "InvalidParameterException": { - "base": "The specified parameter is invalid. Review the available parameters for the API request.
", + "base": "The specified parameter isn't valid. Review the available parameters for the API request.
", "refs": { } }, @@ -1062,7 +1093,7 @@ } }, "KernelCapabilities": { - "base": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
", + "base": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.
", "refs": { "LinuxParameters$capabilities": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.
The infrastructure on which to run your service. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The launch type that new tasks in the task set uses. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
", "ListServicesRequest$launchType": "The launch type to use when filtering the ListServices results.
The launch type to use when filtering the ListTasks results.
The infrastructure on which to run your standalone task. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL launch type runs your tasks on your on-premise server or virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate.
The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.
The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
", - "Task$launchType": "The infrastructure on which your task is running. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
", + "Task$launchType": "The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
", "TaskSet$launchType": "The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
" } }, "LimitExceededException": { - "base": "The limit for the resource has been exceeded.
", + "base": "The limit for the resource was exceeded.
", "refs": { } }, @@ -1200,16 +1231,16 @@ "LoadBalancers": { "base": null, "refs": { - "CreateServiceRequest$loadBalancers": "A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port that's specified in the service definition are immutable. If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
", - "Service$loadBalancers": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
", - "TaskSet$loadBalancers": "Details on a load balancer that is used with a task set.
" + "Service$loadBalancers": "A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
", + "TaskSet$loadBalancers": "Details on a load balancer that are used with a task set.
" } }, "LogConfiguration": { - "base": "The log configuration 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 may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
The following should be noted when specifying a log configuration for your containers:
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may 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.
For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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.
For tasks on Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
The log configuration 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 configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Understand the following when specifying a log configuration for your containers.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may 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.
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers 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.
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
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 may 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.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may 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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can 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 about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may 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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that isn't listed, 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 would like to have included. However, we don't currently provide support for running modified copies of this software.
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
The version counter for the task. Every time a task experiences a change that starts a CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
The details for the managed agent associated with the task.
" + "SubmitTaskStateChangeRequest$managedAgents": "The details for the managed agent that's associated with the task.
" } }, "ManagedAgents": { @@ -1264,7 +1295,7 @@ } }, "ManagedScaling": { - "base": "The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
", + "base": "The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
", "refs": { "AutoScalingGroupProvider$managedScaling": "The managed scaling settings for the Auto Scaling group capacity provider.
", "AutoScalingGroupProviderUpdate$managedScaling": "The managed scaling settings for the Auto Scaling group capacity provider.
" @@ -1279,36 +1310,36 @@ "ManagedScalingStatus": { "base": null, "refs": { - "ManagedScaling$status": "Whether or not to enable managed scaling for the capacity provider.
" + "ManagedScaling$status": "Determines whether to enable managed scaling for the capacity provider.
" } }, "ManagedScalingStepSize": { "base": null, "refs": { - "ManagedScaling$minimumScalingStepSize": "The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.
The minimum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of 1 is used.
The maximum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of 10000 is used.
The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
", - "AutoScalingGroupProviderUpdate$managedTerminationProtection": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
" + "AutoScalingGroupProvider$managedTerminationProtection": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
", + "AutoScalingGroupProviderUpdate$managedTerminationProtection": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
" } }, "MissingVersionException": { - "base": "Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
", + "base": "Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't use our version information.
", "refs": { } }, "MountPoint": { - "base": "Details on a volume mount point that is used in a container definition.
", + "base": "Details for a volume mount point that's used in a container definition.
", "refs": { "MountPointList$member": null } @@ -1316,7 +1347,7 @@ "MountPointList": { "base": null, "refs": { - "ContainerDefinition$mountPoints": "The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.
The network bindings associated with the container.
", - "ContainerStateChange$networkBindings": "Any network bindings associated with the container.
", + "ContainerStateChange$networkBindings": "Any network bindings that are associated with the container.
", "SubmitContainerStateChangeRequest$networkBindings": "The network bindings of the container.
" } }, "NetworkConfiguration": { "base": "An object representing the network configuration for a task or service.
", "refs": { - "CreateServiceRequest$networkConfiguration": "The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
An object representing the network configuration for a task set.
", "Deployment$networkConfiguration": "The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The network configuration for the task set.
", @@ -1366,7 +1397,7 @@ } }, "NoUpdateAvailableException": { - "base": "There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
", + "base": "There's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.
", "refs": { } }, @@ -1384,7 +1415,7 @@ } }, "PlacementConstraint": { - "base": "An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
If you are using the Fargate launch type, task placement constraints are not supported.
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
If you're using the Fargate launch type, task placement constraints aren't supported.
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
", - "RunTaskRequest$placementConstraints": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
", + "CreateServiceRequest$placementConstraints": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
", + "RunTaskRequest$placementConstraints": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
", "Service$placementConstraints": "The placement constraints for the tasks in the service.
", - "UpdateServiceRequest$placementConstraints": "An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
" + "UpdateServiceRequest$placementConstraints": "An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
" } }, "PlacementStrategies": { "base": null, "refs": { - "CreateServiceRequest$placementStrategy": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.
", - "RunTaskRequest$placementStrategy": "The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.
", + "CreateServiceRequest$placementStrategy": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
", + "RunTaskRequest$placementStrategy": "The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
", "Service$placementStrategy": "The placement strategy that determines how tasks for the service are placed.
", - "UpdateServiceRequest$placementStrategy": "The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
" + "UpdateServiceRequest$placementStrategy": "The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules for each service.
" } }, "PlacementStrategy": { @@ -1422,7 +1453,7 @@ "PlacementStrategyType": { "base": null, "refs": { - "PlacementStrategy$type": "The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that's specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.
The type of device that is available on the container instance. The only supported value is GPU.
The type of device that's available on the container instance. The only supported value is GPU.
The specified platform version does not satisfy the task definition's required capabilities.
", + "base": "The specified platform version doesn't satisfy the required capabilities of the task definition.
", "refs": { } }, "PlatformUnknownException": { - "base": "The specified platform version does not exist.
", + "base": "The specified platform version doesn't exist.
", "refs": { } }, "PortMapping": { - "base": "Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than localhost. There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation or task creation, use the TagResource API action.
", - "RunTaskRequest$propagateTags": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
", - "StartTaskRequest$propagateTags": "Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
" + "CreateServiceRequest$propagateTags": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation or task creation, use the TagResource API action.
", + "RunTaskRequest$propagateTags": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
", + "StartTaskRequest$propagateTags": "Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
" } }, "ProxyConfiguration": { - "base": "The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI
The configuration details for the App Mesh proxy.
For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI
The configuration details for the App Mesh proxy.
For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes, specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for tasks run on Fargate.
The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks hosted on Amazon EC2 instances. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
This parameter isn't supported for tasks run on Fargate.
The specified resource is in-use and cannot be removed.
", + "base": "The specified resource is in-use and can't be removed.
", "refs": { } }, "ResourceNotFoundException": { - "base": "The specified resource could not be found.
", + "base": "The specified resource wasn't found.
", "refs": { } }, @@ -1603,7 +1634,7 @@ "Resources": { "base": null, "refs": { - "ContainerInstance$remainingResources": "For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that's not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
", "RegisterContainerInstanceRequest$totalResources": "The resources available on the instance.
" } @@ -1629,7 +1660,7 @@ "base": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
", "refs": { "CreateTaskSetRequest$scale": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
", - "TaskSet$scale": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
", + "TaskSet$scale": "A floating-point percentage of your desired number of tasks to place and keep running in the task set.
", "UpdateTaskSetRequest$scale": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
" } }, @@ -1642,9 +1673,9 @@ "SchedulingStrategy": { "base": null, "refs": { - "CreateServiceRequest$schedulingStrategy": "The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
The scheduling strategy to use when filtering the ListServices results.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
Fargate tasks do not support the DAEMON scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This taskmeets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.
Fargate tasks don't support the DAEMON scheduling strategy.
An encrypted token value containing session and caller information. Used to authenticate the connection to the container.
" + "Session$tokenValue": "An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.
" } }, "ServerException": { @@ -1680,14 +1711,14 @@ "Service": { "base": "Details on a service within a cluster
", "refs": { - "CreateServiceResponse$service": "The full description of your service following the create call.
A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending on which one was specified during creation.
If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.
If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.
The full description of your service following the create call.
A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending where one was specified when it was created.
If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.
if the service uses the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.
The full description of the deleted service.
", "Services$member": null, "UpdateServiceResponse$service": "The full description of your service following the update call.
" } }, "ServiceEvent": { - "base": "Details on an event associated with a service.
", + "base": "The details for an event that's associated with a service.
", "refs": { "ServiceEvents$member": null } @@ -1707,30 +1738,30 @@ "ServiceFieldList": { "base": null, "refs": { - "DescribeServicesRequest$include": "Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
", + "base": "The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
", "refs": { } }, "ServiceNotFoundException": { - "base": "The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
", + "base": "The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
", "refs": { } }, "ServiceRegistries": { "base": null, "refs": { - "CreateServiceRequest$serviceRegistries": "The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries per service isn't supported.
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
", - "Service$serviceRegistries": "The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
", - "TaskSet$serviceRegistries": "The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
" + "Service$serviceRegistries": "The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
", + "TaskSet$serviceRegistries": "The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
" } }, "ServiceRegistry": { - "base": "Details of the service registry.
", + "base": "The details for the service registry.
", "refs": { "ServiceRegistries$member": null } @@ -1742,7 +1773,7 @@ } }, "Session": { - "base": "The details of the execute command session.
", + "base": "The details for the execute command session.
", "refs": { "ExecuteCommandResponse$session": "The details of the SSM session that was created for this instance of execute-command.
" } @@ -1759,7 +1790,7 @@ "SettingName": { "base": null, "refs": { - "DeleteAccountSettingRequest$name": "The resource name for which to disable the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.
The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.
The name of the account setting you want to list the settings for.
", "PutAccountSettingDefaultRequest$name": "The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.
The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.
The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
The task runningCount is equal to the computedDesiredCount.
The pendingCount is 0.
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING.
The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set sre in STEADY_STATE:
The task runningCount is equal to the computedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions aren't met, the stability status returns STABILIZING.
Additional information about your clusters that are separated by launch type, including:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
Additional information about your clusters that are separated by launch type. They include the following:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.
The Amazon Resource Name (ARN) of the attachment.
", "AttachmentStateChange$status": "The status of the attachment.
", - "Attribute$name": "The name of the attribute. The name must contain between 1 and 128 characters and name may contain letters (uppercase and lowercase), numbers, hyphens, underscores, forward slashes, back slashes, or periods.
The value of the attribute. The value must contain between 1 and 128 characters and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces. The value cannot contain any leading or trailing whitespace.
The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).
The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\), colons (:), or spaces. The value can't can't start or end with a space.
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
", "AutoScalingGroupProvider$autoScalingGroupArn": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
", "CapacityProvider$capacityProviderArn": "The Amazon Resource Name (ARN) that identifies the capacity provider.
", @@ -1829,8 +1860,8 @@ "ClientException$message": null, "Cluster$clusterArn": "The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
A user-generated string that you use to identify your cluster.
", - "Cluster$status": "The status of the cluster. The following are the possible states that will be returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
The status of the cluster. The following are the possible states that are returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.
The status of the capacity providers associated with the cluster. The following are the states that are returned.
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The Amazon Resource Name (ARN) of the container.
", "Container$taskArn": "The ARN of the task.
", @@ -1840,19 +1871,19 @@ "Container$runtimeId": "The ID of the Docker container.
", "Container$lastStatus": "The last known status of the container.
", "Container$reason": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
", - "Container$cpu": "The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.
The hard limit (in MiB) of memory set for the container.
", "Container$memoryReservation": "The soft limit (in MiB) of memory set for the container.
", - "ContainerDefinition$name": "The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
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 either repository-url/image:tag or repository-url/image@digest . 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.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
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).
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
The hostname parameter is not supported if you are using the awsvpc network mode.
The user 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.
When running tasks using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . 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.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
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).
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
The hostname parameter is not supported if you're using the awsvpc network mode.
The user 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.
When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
The name of a container.
", "ContainerInstance$containerInstanceArn": "The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
", - "ContainerInstance$capacityProviderName": "The capacity provider associated with the container instance.
", - "ContainerInstance$status": "The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
The capacity provider that's associated with the container instance.
", + "ContainerInstance$status": "The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks aren't placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
The reason that the container instance reached its current status.
", "ContainerOverride$name": "The name of the container that receives the override. This parameter is required if any override is specified.
", "ContainerStateChange$containerName": "The name of the container.
", @@ -1860,33 +1891,33 @@ "ContainerStateChange$runtimeId": "The ID of the Docker container.
", "ContainerStateChange$reason": "The reason for the state change.
", "ContainerStateChange$status": "The status of the container.
", - "CreateCapacityProviderRequest$name": "The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with \"aws\", \"ecs\", or \"fargate\".
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
", + "CreateCapacityProviderRequest$name": "The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with \"aws\", \"ecs\", or \"fargate\".
The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
", "CreateServiceRequest$serviceName": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
", - "CreateServiceRequest$taskDefinition": "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
", - "CreateServiceRequest$platformVersion": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
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. 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.
The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 32 ASCII characters are allowed.
", + "CreateServiceRequest$platformVersion": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
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. 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.
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
", "CreateTaskSetRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
", "CreateTaskSetRequest$externalId": "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.
The task definition for the tasks in the task set to use.
", - "CreateTaskSetRequest$platformVersion": "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
", - "DeleteAccountSettingRequest$principalArn": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
", + "CreateTaskSetRequest$platformVersion": "The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.
The identifier that you provide to ensure the idempotency of the request. It's case sensitive and must be unique. It can be up to 32 ASCII characters are allowed.
", + "DeleteAccountSettingRequest$principalArn": "The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
", "DeleteAttributesRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
", "DeleteCapacityProviderRequest$capacityProvider": "The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
", "DeleteClusterRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to delete.
", "DeleteServiceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
", "DeleteServiceRequest$service": "The name of the service to delete.
", - "DeleteTaskSetRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.
", + "DeleteTaskSetRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.
", "DeleteTaskSetRequest$service": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
", "DeleteTaskSetRequest$taskSet": "The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", "Deployment$id": "The ID of the deployment.
", - "Deployment$status": "The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
The status of the deployment. The following describes each state.
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
The most recent task definition that was specified for the tasks in the service to use.
", - "Deployment$platformVersion": "The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..
A description of the rollout state of a deployment.
", "DeregisterContainerInstanceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
", @@ -1903,7 +1934,7 @@ "Device$hostPath": "The path for the device on the host container instance.
", "Device$containerPath": "The path inside the container at which to expose the host device.
", "DiscoverPollEndpointRequest$containerInstance": "The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
", + "DiscoverPollEndpointRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
", "DiscoverPollEndpointResponse$endpoint": "The endpoint for the Amazon ECS agent to poll.
", "DiscoverPollEndpointResponse$telemetryEndpoint": "The telemetry endpoint for the Amazon ECS agent.
", "DockerLabelsMap$key": null, @@ -1937,53 +1968,53 @@ "GpuIds$member": null, "HostEntry$hostname": "The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not 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.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
When the host parameter is used, specify a sourcePath to declare 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 the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value 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.
If you're using the Fargate launch type, the sourcePath parameter is not supported.
The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
", "InferenceAcceleratorOverride$deviceName": "The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
", "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.
", - "ListAccountSettingsRequest$value": "The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
", + "ListAccountSettingsRequest$value": "The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
", "ListAccountSettingsRequest$principalArn": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings 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.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
", - "ListAttributesRequest$attributeName": "The name of the attribute with which to filter the results.
", - "ListAttributesRequest$attributeValue": "The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
", - "ListAttributesRequest$nextToken": "The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The name of the attribute to filter the results with.
", + "ListAttributesRequest$attributeValue": "The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.
", + "ListAttributesRequest$nextToken": "The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes 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.
The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListClusters request. When the results of a ListClusters 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.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
", "ListContainerInstancesRequest$filter": "You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances 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.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.
The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListServices request. When the results of a ListServices 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.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
", - "ListTaskDefinitionFamiliesRequest$familyPrefix": "The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
", + "ListTaskDefinitionFamiliesRequest$familyPrefix": "The familyPrefix is a string that's used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies 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.
The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions 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.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.
The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.
The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.
The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.
The nextToken value to include in a future ListTasks request. When the results of a ListTasks 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.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a Classic Load Balancer, omit the target group ARN.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you must choose ip as the target type, not instance. Do this when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.
The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
", "LoadBalancer$containerName": "The name of the container (as it appears in a container definition) to associate with the load balancer.
", "LogConfigurationOptionsMap$key": null, "LogConfigurationOptionsMap$value": null, "ManagedAgent$reason": "The reason for why the managed agent is in the state it is in.
", "ManagedAgent$lastStatus": "The last known status of the managed agent.
", - "ManagedAgentStateChange$containerName": "The name of the container associated with the managed agent.
", + "ManagedAgentStateChange$containerName": "The name of the container that's associated with the managed agent.
", "ManagedAgentStateChange$status": "The status of the managed agent.
", "ManagedAgentStateChange$reason": "The reason for the status of the managed agent.
", "MountPoint$sourceVolume": "The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.
The private IPv4 address for the network interface.
", "NetworkInterface$ipv6Address": "The private IPv6 address for the network interface.
", "PlacementConstraint$expression": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The name of the container that will serve as the App Mesh proxy.
", "PutAccountSettingDefaultRequest$value": "The account setting value for the specified principal ARN. Accepted values are enabled and disabled.
The account setting value for the specified principal ARN. Accepted values are enabled and disabled.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
", - "PutClusterCapacityProvidersRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
", - "RegisterContainerInstanceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
", + "PutClusterCapacityProvidersRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
", + "RegisterContainerInstanceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.
", "RegisterContainerInstanceRequest$instanceIdentityDocument": "The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The ARN of the container instance (if it was previously registered).
", - "RegisterTaskDefinitionRequest$family": "You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
", "RegisterTaskDefinitionRequest$executionRoleArn": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
", - "RegisterTaskDefinitionRequest$cpu": "The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the full ARN of the secret.
The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you're using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.
The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
", + "Resource$type": "The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.
The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.
If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
", "RunTaskRequest$group": "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
The platform version the task should use. A platform version is only specified for tasks hosted on Fargate. If one is not specified, the LATEST platform version is used by default. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
", - "RunTaskRequest$startedBy": "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
The full ARN value must match the value that you specified ias the Resource of the IAM principal's permissions policy. For example, if the Resource is arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition ARN value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The family and revision (family:revision) or full ARN of the task definition to run. If a revision isn't specified, the latest ACTIVE revision is used.
The full ARN value must match the value that you specified as the Resource of the IAM principal's permissions policy. For example, if the Resource is arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition ARN value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
The name of the secret.
", - "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 SSM Parameter Store.
If the SSM Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
", + "Service$serviceName": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
", "Service$clusterArn": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
", "Service$status": "The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
The platform version on which to run your service. A platform version is only specified for tasks hosted on Fargate. If one is not specified, the LATEST platform version is used by default. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service are running on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX.
The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
", - "Service$roleArn": "The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
", + "Service$roleArn": "The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
", "Service$createdBy": "The principal that created the service.
", - "ServiceEvent$id": "The ID string of the event.
", + "ServiceEvent$id": "The ID string for the event.
", "ServiceEvent$message": "The event message.
", "ServiceRegistry$registryArn": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
", - "ServiceRegistry$containerName": "The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.
The ID of the execute command session.
", "Session$streamUrl": "A URL back to managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
", - "Setting$value": "Whether the account setting is enabled or disabled for the specified resource.
", - "Setting$principalArn": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
", - "StartTaskRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
", + "Setting$value": "Determines whether the account setting is enabled or disabled for the specified resource.
", + "Setting$principalArn": "The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
", + "StartTaskRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.
", "StartTaskRequest$group": "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
", "StartTaskRequest$referenceId": "The reference ID to use for the task.
", - "StartTaskRequest$startedBy": "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.
The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
", "StopTaskRequest$task": "The task ID or full Amazon Resource Name (ARN) of the task to stop.
", - "StopTaskRequest$reason": "An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
", + "StopTaskRequest$reason": "An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
", "StringList$member": null, "StringMap$key": null, "StringMap$value": null, @@ -2065,30 +2096,30 @@ "SubmitTaskStateChangeRequest$status": "The status of the state change request.
", "SubmitTaskStateChangeRequest$reason": "The reason for the state change request.
", "SubmitTaskStateChangeResponse$acknowledgment": "Acknowledgement of the state change.
", - "SystemControl$namespace": "The namespaced kernel parameter for which to set a value.
The value for the namespaced kernel parameter specified in namespace.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
", - "Task$availabilityZone": "The availability zone of the task.
", - "Task$capacityProviderName": "The capacity provider associated with the task.
", + "SystemControl$namespace": "The namespaced kernel parameter to set a value for.
The value for the namespaced kernel parameter that's specified in namespace.
The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
", + "Task$availabilityZone": "The Availability Zone for the task.
", + "Task$capacityProviderName": "The capacity provider that's associated with the task.
", "Task$clusterArn": "The ARN of the cluster that hosts the task.
", "Task$containerInstanceArn": "The ARN of the container instances that host the task.
", - "Task$cpu": "The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, 1024). It can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an integer that indicates the CPU units when the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The desired status of the task. For more information, see Task Lifecycle.
", - "Task$group": "The name of the task group associated with the task.
", - "Task$lastStatus": "The last known status of the task. For more information, see Task Lifecycle.
", - "Task$memory": "The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The name of the task group that's associated with the task.
", + "Task$lastStatus": "The last known status for the task. For more information, see Task Lifecycle.
", + "Task$memory": "The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be expressed as an integer using MiB (for example, 1024). If it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted to an integer indicating the MiB when the task definition is registered.
If you use the EC2 launch type, this field is optional.
If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines the range of supported values for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The platform version where your task runs on. A platform version is only specified for tasks that use the Fargate launch type. If you didn't specify one, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX.).
The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.
The reason that the task was stopped.
", "Task$taskArn": "The Amazon Resource Name (ARN) of the task.
", "Task$taskDefinitionArn": "The ARN of the task definition that creates the task.
", "TaskDefinition$taskDefinitionArn": "The full Amazon Resource Name (ARN) of the task definition.
", - "TaskDefinition$family": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
", - "TaskDefinition$taskRoleArn": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
The name of a family that this task definition is registered to. Up to 255 characters are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
", + "TaskDefinition$taskRoleArn": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
", - "TaskDefinition$cpu": "The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task.
If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks will be run on Fargate, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The number of cpu units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If your tasks runs on Fargate, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The principal that registered the task definition.
", "TaskDefinitionPlacementConstraint$expression": "A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
", "TaskOverride$cpu": "The cpu override for the task.
", @@ -2099,69 +2130,69 @@ "TaskSet$taskSetArn": "The Amazon Resource Name (ARN) of the task set.
", "TaskSet$serviceArn": "The Amazon Resource Name (ARN) of the service the task set exists in.
", "TaskSet$clusterArn": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
", - "TaskSet$startedBy": "The tag specified when a task set is started. If the task set is created by an CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.
The external ID associated with the task set.
If a task set is created by an CodeDeploy deployment, the externalId parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
The task definition the task set is using.
", - "TaskSet$platformVersion": "The Fargate platform version on which the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
", - "TaskSet$platformFamily": "The operating system that your tasks in the set are running on. A platform family is specified only for tasks using the Fargate launch type.
All tasks in the set must have the same value.
", + "TaskSet$startedBy": "The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.
The external ID associated with the task set.
If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
The status of the task set. The following describes each state.
The task set is serving production traffic.
The task set isn't serving production traffic.
The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
The task definition that the task set is using.
", + "TaskSet$platformVersion": "The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
", + "TaskSet$platformFamily": "The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.
All tasks in the set must have the same value.
", "Tmpfs$containerPath": "The absolute file path where the tmpfs volume is to be mounted.
", - "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
", + "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
", "UpdateCapacityProviderRequest$name": "The name of the capacity provider to update.
", "UpdateClusterRequest$cluster": "The name of the cluster to modify the settings for.
", "UpdateClusterSettingsRequest$cluster": "The name of the cluster to modify the settings for.
", "UpdateContainerAgentRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
", - "UpdateContainerAgentRequest$containerInstance": "The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
", + "UpdateContainerAgentRequest$containerInstance": "The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.
", "UpdateContainerInstancesStateRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
", "UpdateServicePrimaryTaskSetRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
", "UpdateServicePrimaryTaskSetRequest$service": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", "UpdateServicePrimaryTaskSetRequest$primaryTaskSet": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
", - "UpdateServiceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
", + "UpdateServiceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.
", "UpdateServiceRequest$service": "The name of the service to update.
", "UpdateServiceRequest$taskDefinition": "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
", - "UpdateTaskSetRequest$service": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", + "UpdateServiceRequest$platformVersion": "The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.
", + "UpdateTaskSetRequest$service": "The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.
", "UpdateTaskSetRequest$taskSet": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", "VersionInfo$agentVersion": "The version number of the Amazon ECS container agent.
", "VersionInfo$agentHash": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
", - "VersionInfo$dockerVersion": "The Docker version running on the container instance.
", + "VersionInfo$dockerVersion": "The Docker version that's running on the container instance.
", "Volume$name": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
The name of another container within the same task definition from which to mount volumes.
" + "VolumeFrom$sourceContainer": "The name of another container within the same task definition to mount volumes from.
" } }, "StringList": { "base": null, "refs": { - "AwsVpcConfiguration$subnets": "The IDs of the subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
The IDs of the security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
The capacity providers associated with the cluster.
", "ContainerDefinition$links": "The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
The command that is 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. If there are multiple arguments, each argument should be a separated string in the array.
Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
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. If there are multiple arguments, each argument is a separated string in the array.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
This parameter is not supported for Windows containers.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"
", + "ContainerDefinition$dockerSecurityOptions": "A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"
", "ContainerOverride$command": "The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
", - "CreateClusterRequest$capacityProviders": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
", + "CreateClusterRequest$capacityProviders": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
", "DescribeCapacityProvidersRequest$capacityProviders": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
", "DescribeContainerInstancesRequest$containerInstances": "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
", "DescribeServicesRequest$services": "A list of services to describe. You may specify up to 10 services to describe in a single operation.
", "DescribeTaskSetsRequest$taskSets": "The ID or full Amazon Resource Name (ARN) of task sets to describe.
", "DescribeTasksRequest$tasks": "A list of up to 100 task IDs or full ARN entries.
", - "HealthCheck$command": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, you should enclose the list of commands in brackets, as shown below.
[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.
\"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\"
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.
A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in brackets.
[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
You don't need to include the brackets when you use the Amazon Web Services Management Console.
\"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\"
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel capability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
", + "ListClustersResponse$clusterArns": "The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.
", "ListContainerInstancesResponse$containerInstanceArns": "The list of container instances with full ARN entries for each container instance associated with the specified cluster.
", - "ListServicesResponse$serviceArns": "The list of full ARN entries for each service associated with the specified cluster.
", + "ListServicesResponse$serviceArns": "The list of full ARN entries for each service that's associated with the specified cluster.
", "ListTaskDefinitionFamiliesResponse$families": "The list of task definition family names that match the ListTaskDefinitionFamilies request.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
The list of task ARN entries for the ListTasks request.
The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
When the stringSetValue type is set, the value of the resource must be a string type.
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
", + "StartTaskRequest$containerInstances": "The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.
", "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\"
A list of container instance IDs or full ARN entries.
" } @@ -2204,7 +2235,7 @@ } }, "SystemControl": { - "base": "A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect.
For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.
We don't recommend that you specify network-related systemControls parameters for multiple containers in a single task. This task also uses either the awsvpc or host network mode. It does it for the following reasons.
For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that's started last determines which systemControls take effect.
For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter and that of all containers of any tasks running on that container instance.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.
We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that's applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The tags for the resource.
", - "RegisterContainerInstanceRequest$tags": "The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The list of tags associated with the task definition.
", "RunTaskRequest$tags": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize the task. Each tag consists of a key and an optional value. You define both the key and value.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The target container is not properly configured with the execute command agent or the container is no longer active or running.
", + "base": "The target container isn't properly configured with the execute command agent or the container is no longer active or running.
", "refs": { } }, "TargetNotFoundException": { - "base": "The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
", + "base": "The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
", "refs": { } }, "TargetType": { "base": null, "refs": { - "Attribute$targetType": "The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
", - "ListAttributesRequest$targetType": "The type of the target with which to list attributes.
" + "Attribute$targetType": "The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
", + "ListAttributesRequest$targetType": "The type of the target to list attributes with.
" } }, "Task": { @@ -2308,7 +2339,7 @@ "TaskDefinitionFamilyStatus": { "base": null, "refs": { - "ListTaskDefinitionFamiliesRequest$status": "The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Determines whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.
Task placement constraints are not supported for tasks run on Fargate.
An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.
Task placement constraints aren't supported for tasks run on Fargate.
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
", - "TaskDefinition$placementConstraints": "An array of placement constraint objects to use for tasks.
This parameter is not supported for tasks run on Fargate.
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
", + "TaskDefinition$placementConstraints": "An array of placement constraint objects to use for tasks.
This parameter isn't supported for tasks run on Fargate.
The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The status of the task definition.
" } }, @@ -2358,14 +2389,14 @@ "TaskFieldList": { "base": null, "refs": { - "DescribeTasksRequest$include": "Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
The overrides associated with a task.
", + "base": "The overrides that are associated with a task.
", "refs": { - "RunTaskRequest$overrides": "A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
", - "StartTaskRequest$overrides": "A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
", + "StartTaskRequest$overrides": "A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides.
" } }, @@ -2388,11 +2419,11 @@ "TaskSetFieldList": { "base": null, "refs": { - "DescribeTaskSetsRequest$include": "Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
", + "base": "The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
", "refs": { } }, @@ -2406,7 +2437,7 @@ "TaskStopCode": { "base": null, "refs": { - "Task$stopCode": "The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
The Unix timestamp for when the container instance was registered.
", - "Deployment$createdAt": "The Unix timestamp for when the service deployment was created.
", - "Deployment$updatedAt": "The Unix timestamp for when the service deployment was last updated.
", - "ManagedAgent$lastStartedAt": "The Unix timestamp for when the managed agent was last started.
", - "Service$createdAt": "The Unix timestamp for when the service was created.
", - "ServiceEvent$createdAt": "The Unix timestamp for when the event was triggered.
", - "SubmitTaskStateChangeRequest$pullStartedAt": "The Unix timestamp for when the container image pull began.
", - "SubmitTaskStateChangeRequest$pullStoppedAt": "The Unix timestamp for when the container image pull completed.
", - "SubmitTaskStateChangeRequest$executionStoppedAt": "The Unix timestamp for when the task execution stopped.
", - "Task$connectivityAt": "The Unix timestamp for when the task last went into CONNECTED status.
The Unix timestamp for when the task was created (the task entered the PENDING state).
The Unix timestamp for when the task execution stopped.
", - "Task$pullStartedAt": "The Unix timestamp for when the container image pull began.
", - "Task$pullStoppedAt": "The Unix timestamp for when the container image pull completed.
", - "Task$startedAt": "The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).
The Unix timestamp for when the task definition was registered.
", - "TaskDefinition$deregisteredAt": "The Unix timestamp for when the task definition was deregistered.
", - "TaskSet$createdAt": "The Unix timestamp for when the task set was created.
", - "TaskSet$updatedAt": "The Unix timestamp for when the task set was last updated.
", - "TaskSet$stabilityStatusAt": "The Unix timestamp for when the task set stability status was retrieved.
" + "ContainerInstance$registeredAt": "The Unix timestamp for the time when the container instance was registered.
", + "Deployment$createdAt": "The Unix timestamp for the time when the service deployment was created.
", + "Deployment$updatedAt": "The Unix timestamp for the time when the service deployment was last updated.
", + "InstanceHealthCheckResult$lastUpdated": "The Unix timestamp for when the container instance health status was last updated.
", + "InstanceHealthCheckResult$lastStatusChange": "The Unix timestamp for when the container instance health status last changed.
", + "ManagedAgent$lastStartedAt": "The Unix timestamp for the time when the managed agent was last started.
", + "Service$createdAt": "The Unix timestamp for the time when the service was created.
", + "ServiceEvent$createdAt": "The Unix timestamp for the time when the event was triggered.
", + "SubmitTaskStateChangeRequest$pullStartedAt": "The Unix timestamp for the time when the container image pull started.
", + "SubmitTaskStateChangeRequest$pullStoppedAt": "The Unix timestamp for the time when the container image pull completed.
", + "SubmitTaskStateChangeRequest$executionStoppedAt": "The Unix timestamp for the time when the task execution stopped.
", + "Task$connectivityAt": "The Unix timestamp for the time when the task last went into CONNECTED status.
The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.
The Unix timestamp for the time when the task execution stopped.
", + "Task$pullStartedAt": "The Unix timestamp for the time when the container image pull began.
", + "Task$pullStoppedAt": "The Unix timestamp for the time when the container image pull completed.
", + "Task$startedAt": "The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.
The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.
The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.
The Unix timestamp for the time when the task definition was registered.
", + "TaskDefinition$deregisteredAt": "The Unix timestamp for the time when the task definition was deregistered.
", + "TaskSet$createdAt": "The Unix timestamp for the time when the task set was created.
", + "TaskSet$updatedAt": "The Unix timestamp for the time when the task set was last updated.
", + "TaskSet$stabilityStatusAt": "The Unix timestamp for the time when the task set stability status was retrieved.
" } }, "Tmpfs": { @@ -2453,7 +2486,7 @@ "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.
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.
A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.
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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096.
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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
The specified task is not supported in this Region.
", + "base": "The specified task isn't supported in this Region.
", "refs": { } }, @@ -2547,7 +2580,7 @@ } }, "UpdateInProgressException": { - "base": "There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
The Docker and Amazon ECS container agent version information about a container instance.
", "refs": { "ContainerInstance$versionInfo": "The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
", - "RegisterContainerInstanceRequest$versionInfo": "The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
" + "RegisterContainerInstanceRequest$versionInfo": "The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
" } }, "Volume": { - "base": "A data volume used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.
A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.
A list of volume definitions in JSON format that containers in your task may use.
", - "TaskDefinition$volumes": "The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters are not supported for tasks run on Fargate.
A list of volume definitions in JSON format that containers in your task might use.
", + "TaskDefinition$volumes": "The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
The host and sourcePath parameters aren't supported for tasks run on Fargate.
AWS Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. Resilience Hub offers continuous resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
", + "operations": { + "AddDraftAppVersionResourceMappings": "Adds the resource mapping for the draft application version.
", + "CreateApp": "Creates a Resilience Hub application. A Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five–CloudFormation stacks, and an appropriate resiliency policy.
<p>After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).</p> Creates a new recommendation template.
", + "CreateResiliencyPolicy": "Creates a resiliency policy for an application.
", + "DeleteApp": "Deletes an AWS Resilience Hub application. This is a destructive action that can't be undone.
", + "DeleteAppAssessment": "Deletes an AWS Resilience Hub application assessment. This is a destructive action that can't be undone.
", + "DeleteRecommendationTemplate": "Deletes a recommendation template. This is a destructive action that can't be undone.
", + "DeleteResiliencyPolicy": "Deletes a resiliency policy. This is a destructive action that can't be undone.
", + "DescribeApp": "Describes an AWS Resilience Hub application.
", + "DescribeAppAssessment": "Describes an assessment for an AWS Resilience Hub application.
", + "DescribeAppVersionResourcesResolutionStatus": "Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
Describes details about an AWS Resilience Hub
", + "DescribeDraftAppVersionResourcesImportStatus": "Describes the status of importing resources to an application version.
", + "DescribeResiliencyPolicy": "Describes a specified resiliency policy for an AWS Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
", + "ImportResourcesToDraftAppVersion": "Imports resources from sources such as a CloudFormation stack, resource-groups, or application registry app to a draft application version.
", + "ListAlarmRecommendations": "Lists the alarm recommendations for a AWS Resilience Hub application.
", + "ListAppAssessments": "Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.
", + "ListAppComponentCompliances": "Lists the compliances for an AWS Resilience Hub component.
", + "ListAppComponentRecommendations": "Lists the recommendations for an AWS Resilience Hub component.
", + "ListAppVersionResourceMappings": "Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
", + "ListAppVersionResources": "Lists all the resources in an application version.
", + "ListAppVersions": "Lists the different versions for the Resilience Hub applications.
", + "ListApps": "Lists your Resilience Hub applications.
", + "ListRecommendationTemplates": "Lists the recommendation templates for the Resilience Hub applications.
", + "ListResiliencyPolicies": "Lists the resiliency policies for the Resilience Hub applications.
", + "ListSopRecommendations": "Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
", + "ListSuggestedResiliencyPolicies": "Lists the suggested resiliency policies for the Resilience Hub applications.
", + "ListTagsForResource": "Lists the tags for your resources in your Resilience Hub applications.
", + "ListTestRecommendations": "Lists the test recommendations for the Resilience Hub application.
", + "ListUnsupportedAppVersionResources": "Lists the resources that are not currently supported in AWS Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
", + "PublishAppVersion": "Publishes a new version of a specific Resilience Hub application.
", + "PutDraftAppVersionTemplate": "Adds or updates the app template for a draft version of a Resilience Hub app.
", + "RemoveDraftAppVersionResourceMappings": "Removes resource mappings from a draft application version.
", + "ResolveAppVersionResources": "Resolves the resources for an application version.
", + "StartAppAssessment": "Creates a new application assessment for an application.
", + "TagResource": "Applies one or more tags to a resource.
", + "UntagResource": "Removes one or more tags from a resource.
", + "UpdateApp": "Updates an application.
", + "UpdateResiliencyPolicy": "Updates a resiliency policy.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.
", + "refs": { + } + }, + "AddDraftAppVersionResourceMappingsRequest": { + "base": null, + "refs": { + } + }, + "AddDraftAppVersionResourceMappingsResponse": { + "base": null, + "refs": { + } + }, + "AlarmRecommendation": { + "base": "Defines a recommendation for a CloudWatch alarm.
", + "refs": { + "AlarmRecommendationList$member": null + } + }, + "AlarmRecommendationList": { + "base": null, + "refs": { + "ListAlarmRecommendationsResponse$alarmRecommendations": "The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes application component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.
" + } + }, + "AlarmType": { + "base": null, + "refs": { + "AlarmRecommendation$type": "The type of alarm recommendation.
" + } + }, + "App": { + "base": "Defines a Resilience Hub application.
", + "refs": { + "CreateAppResponse$app": "The created application returned as an object with details including compliance status, creation time, description, resiliency score, and more.
", + "DescribeAppResponse$app": "The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
", + "UpdateAppResponse$app": "The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.
" + } + }, + "AppAssessment": { + "base": "Defines an application assessment.
", + "refs": { + "DescribeAppAssessmentResponse$assessment": "The assessment for an AWS Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.
", + "StartAppAssessmentResponse$assessment": "The assessment created.
" + } + }, + "AppAssessmentSummary": { + "base": "Defines an application assessment summary.
", + "refs": { + "AppAssessmentSummaryList$member": null + } + }, + "AppAssessmentSummaryList": { + "base": null, + "refs": { + "ListAppAssessmentsResponse$assessmentSummaries": "The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
" + } + }, + "AppComplianceStatusType": { + "base": null, + "refs": { + "App$complianceStatus": "The current status of compliance for the resiliency policy.
", + "AppSummary$complianceStatus": "The current status of compliance for the resiliency policy.
" + } + }, + "AppComponent": { + "base": "Defines an application component.
", + "refs": { + "AppComponentList$member": null + } + }, + "AppComponentCompliance": { + "base": "Defines the compliance of an application component against the resiliency policy.
", + "refs": { + "ComponentCompliancesList$member": null + } + }, + "AppComponentList": { + "base": null, + "refs": { + "PhysicalResource$appComponents": "The application components that belong to this resource.
" + } + }, + "AppStatusType": { + "base": null, + "refs": { + "App$status": "The status of the action.
" + } + }, + "AppSummary": { + "base": "Defines an application summary.
", + "refs": { + "AppSummaryList$member": null + } + }, + "AppSummaryList": { + "base": null, + "refs": { + "ListAppsResponse$appSummaries": "Summaries for the Resilience Hub application.
" + } + }, + "AppTemplateBody": { + "base": null, + "refs": { + "DescribeAppVersionTemplateResponse$appTemplateBody": "The body of the template.
", + "PutDraftAppVersionTemplateRequest$appTemplateBody": "A JSON string that contains the body of the app template.
" + } + }, + "AppVersionList": { + "base": null, + "refs": { + "ListAppVersionsResponse$appVersions": "The version of the application.
" + } + }, + "AppVersionSummary": { + "base": "The version of the application.
", + "refs": { + "AppVersionList$member": null + } + }, + "Arn": { + "base": null, + "refs": { + "AddDraftAppVersionResourceMappingsRequest$appArn": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) for a recommendation template.
", + "DeleteRecommendationTemplateResponse$recommendationTemplateArn": "The Amazon Resource Name (ARN) for a recommendation template.
", + "DeleteResiliencyPolicyRequest$policyArn": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) for a recommendation template.
", + "ListSopRecommendationsRequest$assessmentArn": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub application.
", + "ListTestRecommendationsRequest$assessmentArn": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:dcps:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) for the recommendation template.
", + "RemoveDraftAppVersionResourceMappingsRequest$appArn": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resource.
", + "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "UpdateAppRequest$appArn": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: arn:partition:dcps:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
The Amazon Resource Names (ARNs) for the resources that you want to import.
", + "ImportResourcesToDraftAppVersionResponse$sourceArns": "The Amazon Resource Names (ARNs) for the resources that you imported.
" + } + }, + "AssessmentCompliance": { + "base": null, + "refs": { + "AppAssessment$compliance": "The application compliance against the resiliency policy.
", + "AppComponentCompliance$compliance": "The compliance of the application component against the resiliency policy.
", + "ConfigRecommendation$compliance": "The current compliance against the resiliency policy before applying the configuration change.
" + } + }, + "AssessmentInvoker": { + "base": null, + "refs": { + "AppAssessment$invoker": "The entity that invoked the assessment.
", + "AppAssessmentSummary$invoker": "The entity that invoked the assessment.
", + "ListAppAssessmentsRequest$invoker": "Specifies the entity that invoked a specific assessment, either a User or the System.
The current status of the assessment for the resiliency policy.
", + "AppAssessmentSummary$assessmentStatus": "The current status of the assessment for the resiliency policy.
", + "AssessmentStatusList$member": null, + "DeleteAppAssessmentResponse$assessmentStatus": "The current status of the assessment for the resiliency policy.
" + } + }, + "AssessmentStatusList": { + "base": null, + "refs": { + "ListAppAssessmentsRequest$assessmentStatus": "The current status of the assessment for the resiliency policy.
" + } + }, + "AwsRegion": { + "base": null, + "refs": { + "PhysicalResourceId$awsRegion": "The Amazon Web Services Region that the physical resource is located in.
", + "RecommendationItem$targetRegion": "The target region.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "DeleteAppRequest$forceDelete": "A boolean option to force the deletion of a Resilience Hub application.
", + "ListAppAssessmentsRequest$reverseOrder": "The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.
Specifies if the recommendation has already been implemented.
", + "RecommendationTemplate$needsReplacements": "Indicates if replacements are needed.
", + "UpdateAppRequest$clearResiliencyPolicyArn": "Specifies if the resiliency policy ARN should be cleared.
" + } + }, + "ClientToken": { + "base": null, + "refs": { + "CreateAppRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "CreateRecommendationTemplateRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "CreateResiliencyPolicyRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "DeleteAppAssessmentRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "DeleteAppRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "DeleteRecommendationTemplateRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "DeleteResiliencyPolicyRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
", + "StartAppAssessmentRequest$clientToken": "Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
" + } + }, + "ComplianceStatus": { + "base": null, + "refs": { + "AppAssessment$complianceStatus": "The current status of the compliance for the resiliency policy.
", + "AppAssessmentSummary$complianceStatus": "The current status of compliance for the resiliency policy.
", + "AppComponentCompliance$status": "The status of the action.
", + "DisruptionCompliance$complianceStatus": "The current status of compliance for the resiliency policy.
", + "ListAppAssessmentsRequest$complianceStatus": "The current status of compliance for the resiliency policy.
", + "RecommendationDisruptionCompliance$expectedComplianceStatus": "The expected compliance status after applying the recommended configuration change.
" + } + }, + "ComponentCompliancesList": { + "base": null, + "refs": { + "ListAppComponentCompliancesResponse$componentCompliances": "The compliances for an AWS Resilience Hub application component, returned as an object. This object contains component names, compliances, costs, resiliency scores, outage scores, and more.
" + } + }, + "ComponentRecommendation": { + "base": "Defines recommendations for a Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
", + "refs": { + "ComponentRecommendationList$member": null + } + }, + "ComponentRecommendationList": { + "base": null, + "refs": { + "ListAppComponentRecommendationsResponse$componentRecommendations": "The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.
" + } + }, + "ConfigRecommendation": { + "base": "Defines a configuration recommendation.
", + "refs": { + "ConfigRecommendationList$member": null + } + }, + "ConfigRecommendationList": { + "base": null, + "refs": { + "ComponentRecommendation$configRecommendations": "The list of recommendations.
" + } + }, + "ConfigRecommendationOptimizationType": { + "base": null, + "refs": { + "ConfigRecommendation$optimizationType": "The type of optimization.
" + } + }, + "ConflictException": { + "base": "Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
", + "refs": { + } + }, + "Cost": { + "base": "Defines a cost object.
", + "refs": { + "AppAssessment$cost": "The cost for the application.
", + "AppAssessmentSummary$cost": "The cost for the application.
", + "AppComponentCompliance$cost": "The cost for the application.
", + "ConfigRecommendation$cost": "The cost for the application.
" + } + }, + "CostFrequency": { + "base": null, + "refs": { + "Cost$frequency": "The cost frequency.
" + } + }, + "CreateAppRequest": { + "base": null, + "refs": { + } + }, + "CreateAppResponse": { + "base": null, + "refs": { + } + }, + "CreateRecommendationTemplateRequest": { + "base": null, + "refs": { + } + }, + "CreateRecommendationTemplateResponse": { + "base": null, + "refs": { + } + }, + "CreateResiliencyPolicyRequest": { + "base": null, + "refs": { + } + }, + "CreateResiliencyPolicyResponse": { + "base": null, + "refs": { + } + }, + "CurrencyCode": { + "base": null, + "refs": { + "Cost$currency": "The cost currency, for example USD.
The Amazon Web Services account that owns the physical resource.
", + "RecommendationItem$targetAccountId": "The target account identifier.
" + } + }, + "DataLocationConstraint": { + "base": null, + "refs": { + "CreateResiliencyPolicyRequest$dataLocationConstraint": "Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
", + "ResiliencyPolicy$dataLocationConstraint": "Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
", + "UpdateResiliencyPolicyRequest$dataLocationConstraint": "Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
" + } + }, + "DeleteAppAssessmentRequest": { + "base": null, + "refs": { + } + }, + "DeleteAppAssessmentResponse": { + "base": null, + "refs": { + } + }, + "DeleteAppRequest": { + "base": null, + "refs": { + } + }, + "DeleteAppResponse": { + "base": null, + "refs": { + } + }, + "DeleteRecommendationTemplateRequest": { + "base": null, + "refs": { + } + }, + "DeleteRecommendationTemplateResponse": { + "base": null, + "refs": { + } + }, + "DeleteResiliencyPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteResiliencyPolicyResponse": { + "base": null, + "refs": { + } + }, + "DescribeAppAssessmentRequest": { + "base": null, + "refs": { + } + }, + "DescribeAppAssessmentResponse": { + "base": null, + "refs": { + } + }, + "DescribeAppRequest": { + "base": null, + "refs": { + } + }, + "DescribeAppResponse": { + "base": null, + "refs": { + } + }, + "DescribeAppVersionResourcesResolutionStatusRequest": { + "base": null, + "refs": { + } + }, + "DescribeAppVersionResourcesResolutionStatusResponse": { + "base": null, + "refs": { + } + }, + "DescribeAppVersionTemplateRequest": { + "base": null, + "refs": { + } + }, + "DescribeAppVersionTemplateResponse": { + "base": null, + "refs": { + } + }, + "DescribeDraftAppVersionResourcesImportStatusRequest": { + "base": null, + "refs": { + } + }, + "DescribeDraftAppVersionResourcesImportStatusResponse": { + "base": null, + "refs": { + } + }, + "DescribeResiliencyPolicyRequest": { + "base": null, + "refs": { + } + }, + "DescribeResiliencyPolicyResponse": { + "base": null, + "refs": { + } + }, + "DisruptionCompliance": { + "base": "Defines the compliance against the resiliency policy for a disruption.
", + "refs": { + "AssessmentCompliance$value": null + } + }, + "DisruptionPolicy": { + "base": null, + "refs": { + "CreateResiliencyPolicyRequest$policy": "The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
", + "ResiliencyPolicy$policy": "The resiliency policy.
", + "UpdateResiliencyPolicyRequest$policy": "The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
" + } + }, + "DisruptionResiliencyScore": { + "base": null, + "refs": { + "ResiliencyScore$disruptionScore": "The disruption score for a valid key.
" + } + }, + "DisruptionType": { + "base": null, + "refs": { + "AssessmentCompliance$key": null, + "DisruptionPolicy$key": null, + "DisruptionResiliencyScore$key": null, + "RecommendationCompliance$key": null + } + }, + "DocumentName": { + "base": null, + "refs": { + "SopRecommendation$name": "The name of the SOP recommendation.
", + "TestRecommendation$name": "The name of the test recommendation.
" + } + }, + "Double": { + "base": null, + "refs": { + "App$resiliencyScore": "The current resiliency score for the application.
", + "AppAssessmentSummary$resiliencyScore": "The current resiliency score for the application.
", + "AppSummary$resiliencyScore": "The current resiliency score for the application.
", + "Cost$amount": "The cost amount.
", + "DisruptionResiliencyScore$value": null, + "ResiliencyScore$score": "The outage score for a valid key.
" + } + }, + "EntityDescription": { + "base": null, + "refs": { + "AlarmRecommendation$description": "The description of the recommendation.
", + "App$description": "The optional description for an app.
", + "AppSummary$description": "The optional description for an app.
", + "ConfigRecommendation$description": "The optional description for an app.
", + "CreateAppRequest$description": "The optional description for an app.
", + "CreateResiliencyPolicyRequest$policyDescription": "The description for the policy.
", + "ResiliencyPolicy$policyDescription": "The description for the policy.
", + "SuggestedChangesList$member": null, + "TestRecommendation$intent": "The intent of the test recommendation.
", + "UpdateAppRequest$description": "The optional description for an app.
", + "UpdateResiliencyPolicyRequest$policyDescription": "The description for the policy.
" + } + }, + "EntityId": { + "base": null, + "refs": { + "AlarmRecommendation$appComponentName": "The application component for the CloudWatch alarm recommendation.
", + "AppComponentCompliance$appComponentName": "The name of the application component.
", + "ComponentRecommendation$appComponentName": "The name of the application component.
", + "ConfigRecommendation$appComponentName": "The application component name.
", + "SopRecommendation$appComponentName": "The application component name.
", + "TestRecommendation$appComponentName": "The name of the application component.
" + } + }, + "EntityName": { + "base": null, + "refs": { + "App$name": "The name for the application.
", + "AppAssessment$assessmentName": "The name of the assessment.
", + "AppAssessmentSummary$assessmentName": "The name of the assessment.
", + "AppSummary$name": "The name of the application.
", + "ConfigRecommendation$name": "The name of the recommendation configuration.
", + "CreateAppRequest$name": "The name for the application.
", + "CreateRecommendationTemplateRequest$bucketName": "The name of the Amazon S3 bucket that will contain the recommendation template.
", + "CreateRecommendationTemplateRequest$name": "The name for the recommendation template.
", + "CreateResiliencyPolicyRequest$policyName": "The name of the policy
", + "EntityNameList$member": null, + "ListAppAssessmentsRequest$assessmentName": "The name for the assessment.
", + "ListAppsRequest$name": "The name for the one of the listed applications.
", + "ListRecommendationTemplatesRequest$name": "The name for one of the listed recommendation templates.
", + "ListResiliencyPoliciesRequest$policyName": "The name of the policy
", + "LogicalResourceId$resourceGroupName": "The name of the resource group that this resource belongs to.
", + "PhysicalResource$resourceName": "The name of the resource.
", + "RecommendationTemplate$name": "The name for the recommendation template.
", + "ResiliencyPolicy$policyName": "The name of the policy
", + "ResourceMapping$appRegistryAppName": "The name of the application this resource is mapped to.
", + "ResourceMapping$resourceGroupName": "The name of the resource group this resource is mapped to.
", + "ResourceMapping$resourceName": "The name of the resource this resource is mapped to.
", + "StartAppAssessmentRequest$assessmentName": "The name for the assessment.
", + "UpdateResiliencyPolicyRequest$policyName": "The name of the policy
" + } + }, + "EntityNameList": { + "base": null, + "refs": { + "RemoveDraftAppVersionResourceMappingsRequest$appRegistryAppNames": "The names of the registered applications to remove from the resource mappings.
", + "RemoveDraftAppVersionResourceMappingsRequest$resourceGroupNames": "The names of the resource groups to remove from the resource mappings.
", + "RemoveDraftAppVersionResourceMappingsRequest$resourceNames": "The names of the resources to remove from the resource mappings.
" + } + }, + "EntityVersion": { + "base": null, + "refs": { + "AddDraftAppVersionResourceMappingsResponse$appVersion": "The version of the application.
", + "AppAssessment$appVersion": "The version of the application.
", + "AppAssessmentSummary$appVersion": "The version of the application.
", + "AppVersionSummary$appVersion": "The version of the application.
", + "DescribeAppVersionResourcesResolutionStatusRequest$appVersion": "The version of the application.
", + "DescribeAppVersionResourcesResolutionStatusResponse$appVersion": "The version of the application.
", + "DescribeAppVersionTemplateRequest$appVersion": "The version of the application.
", + "DescribeAppVersionTemplateResponse$appVersion": "The version of the application.
", + "DescribeDraftAppVersionResourcesImportStatusResponse$appVersion": "The version of the application.
", + "ImportResourcesToDraftAppVersionResponse$appVersion": "The version of the application.
", + "ListAppVersionResourceMappingsRequest$appVersion": "The version of the application.
", + "ListAppVersionResourcesRequest$appVersion": "The version of the application.
", + "ListUnsupportedAppVersionResourcesRequest$appVersion": "The version of the application.
", + "PublishAppVersionResponse$appVersion": "The version of the application.
", + "PutDraftAppVersionTemplateResponse$appVersion": "The version of the application.
", + "RemoveDraftAppVersionResourceMappingsResponse$appVersion": "The version of the application.
", + "ResolveAppVersionResourcesRequest$appVersion": "The version of the application.
", + "ResolveAppVersionResourcesResponse$appVersion": "The version of the application.
", + "StartAppAssessmentRequest$appVersion": "The version of the application.
" + } + }, + "EstimatedCostTier": { + "base": null, + "refs": { + "ResiliencyPolicy$estimatedCostTier": "Specifies the estimated cost tier of the resiliency policy.
" + } + }, + "FailurePolicy": { + "base": "Defines a failure policy.
", + "refs": { + "DisruptionPolicy$value": null + } + }, + "HaArchitecture": { + "base": null, + "refs": { + "ConfigRecommendation$haArchitecture": "The architecture type.
" + } + }, + "ImportResourcesToDraftAppVersionRequest": { + "base": null, + "refs": { + } + }, + "ImportResourcesToDraftAppVersionResponse": { + "base": null, + "refs": { + } + }, + "InternalServerException": { + "base": "This exception occurs when there is an internal failure in the AWS Resilience Hub service.
", + "refs": { + } + }, + "ListAlarmRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "ListAlarmRecommendationsResponse": { + "base": null, + "refs": { + } + }, + "ListAppAssessmentsRequest": { + "base": null, + "refs": { + } + }, + "ListAppAssessmentsResponse": { + "base": null, + "refs": { + } + }, + "ListAppComponentCompliancesRequest": { + "base": null, + "refs": { + } + }, + "ListAppComponentCompliancesResponse": { + "base": null, + "refs": { + } + }, + "ListAppComponentRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "ListAppComponentRecommendationsResponse": { + "base": null, + "refs": { + } + }, + "ListAppVersionResourceMappingsRequest": { + "base": null, + "refs": { + } + }, + "ListAppVersionResourceMappingsResponse": { + "base": null, + "refs": { + } + }, + "ListAppVersionResourcesRequest": { + "base": null, + "refs": { + } + }, + "ListAppVersionResourcesResponse": { + "base": null, + "refs": { + } + }, + "ListAppVersionsRequest": { + "base": null, + "refs": { + } + }, + "ListAppVersionsResponse": { + "base": null, + "refs": { + } + }, + "ListAppsRequest": { + "base": null, + "refs": { + } + }, + "ListAppsResponse": { + "base": null, + "refs": { + } + }, + "ListRecommendationTemplatesRequest": { + "base": null, + "refs": { + } + }, + "ListRecommendationTemplatesResponse": { + "base": null, + "refs": { + } + }, + "ListResiliencyPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListResiliencyPoliciesResponse": { + "base": null, + "refs": { + } + }, + "ListSopRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "ListSopRecommendationsResponse": { + "base": null, + "refs": { + } + }, + "ListSuggestedResiliencyPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListSuggestedResiliencyPoliciesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "ListTestRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "ListTestRecommendationsResponse": { + "base": null, + "refs": { + } + }, + "ListUnsupportedAppVersionResourcesRequest": { + "base": null, + "refs": { + } + }, + "ListUnsupportedAppVersionResourcesResponse": { + "base": null, + "refs": { + } + }, + "LogicalResourceId": { + "base": "Defines a logical resource identifier.
", + "refs": { + "PhysicalResource$logicalResourceId": "The logical identifier of the resource.
", + "UnsupportedResource$logicalResourceId": "The logical resource identifier for the unsupported resource.
" + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListAlarmRecommendationsRequest$maxResults": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
Null, or the token from a previous call to get the next set of results.
", + "ListAlarmRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppAssessmentsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppAssessmentsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppComponentCompliancesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppComponentCompliancesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppComponentRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppComponentRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionResourceMappingsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppVersionResourceMappingsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionResourcesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppVersionResourcesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppVersionsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppVersionsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListAppsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListAppsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListRecommendationTemplatesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListRecommendationTemplatesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListResiliencyPoliciesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListResiliencyPoliciesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListSopRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListSopRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListSuggestedResiliencyPoliciesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListSuggestedResiliencyPoliciesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListTestRecommendationsRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListTestRecommendationsResponse$nextToken": "The token for the next set of results, or null if there are no more results.
", + "ListUnsupportedAppVersionResourcesRequest$nextToken": "Null, or the token from a previous call to get the next set of results.
", + "ListUnsupportedAppVersionResourcesResponse$nextToken": "The token for the next set of results, or null if there are no more results.
" + } + }, + "PhysicalIdentifierType": { + "base": null, + "refs": { + "PhysicalResourceId$type": "Specifies the type of physical resource identifier.
The resource identifier is an Amazon Resource Name (ARN) .
The resource identifier is a Resilience Hub-native identifier.
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or a Resilience Hub-native identifier.
", + "refs": { + "PhysicalResourceList$member": null + } + }, + "PhysicalResourceId": { + "base": "Defines a physical resource identifier.
", + "refs": { + "PhysicalResource$physicalResourceId": "The physical identifier of the resource.
", + "ResourceMapping$physicalResourceId": "The identifier of this resource.
", + "UnsupportedResource$physicalResourceId": "The physical resource identifier for the unsupported resource.
" + } + }, + "PhysicalResourceList": { + "base": null, + "refs": { + "ListAppVersionResourcesResponse$physicalResources": "The physical resources in the application version.
" + } + }, + "PublishAppVersionRequest": { + "base": null, + "refs": { + } + }, + "PublishAppVersionResponse": { + "base": null, + "refs": { + } + }, + "PutDraftAppVersionTemplateRequest": { + "base": null, + "refs": { + } + }, + "PutDraftAppVersionTemplateResponse": { + "base": null, + "refs": { + } + }, + "RecommendationCompliance": { + "base": null, + "refs": { + "ConfigRecommendation$recommendationCompliance": "The expected compliance against the resiliency policy after applying the configuration change.
" + } + }, + "RecommendationComplianceStatus": { + "base": null, + "refs": { + "ComponentRecommendation$recommendationStatus": "The recommendation status.
" + } + }, + "RecommendationDisruptionCompliance": { + "base": "Defines a disruption compliance recommendation.
", + "refs": { + "RecommendationCompliance$value": null + } + }, + "RecommendationIdList": { + "base": null, + "refs": { + "CreateRecommendationTemplateRequest$recommendationIds": "Identifiers for the recommendations used to create a recommendation template.
", + "RecommendationTemplate$recommendationIds": "Identifiers for the recommendations used in the recommendation template.
" + } + }, + "RecommendationItem": { + "base": "Defines a recommendation.
", + "refs": { + "RecommendationItemList$member": null + } + }, + "RecommendationItemList": { + "base": null, + "refs": { + "AlarmRecommendation$items": "The list of CloudWatch alarm recommendations.
", + "SopRecommendation$items": "The recommendation items.
", + "TestRecommendation$items": "The test recommendation items.
" + } + }, + "RecommendationTemplate": { + "base": "Defines a recommendation template created with the CreateRecommendationTemplate action.
", + "refs": { + "CreateRecommendationTemplateResponse$recommendationTemplate": "The newly created recommendation template, returned as an object. This object includes the template's name, format, status, tags, Amazon S3 bucket location, and more.
", + "RecommendationTemplateList$member": null + } + }, + "RecommendationTemplateList": { + "base": null, + "refs": { + "ListRecommendationTemplatesResponse$recommendationTemplates": "The recommendation templates for the Resilience Hub applications.
" + } + }, + "RecommendationTemplateStatus": { + "base": null, + "refs": { + "DeleteRecommendationTemplateResponse$status": "The status of the action.
", + "RecommendationTemplate$status": "The status of the action.
", + "RecommendationTemplateStatusList$member": null + } + }, + "RecommendationTemplateStatusList": { + "base": null, + "refs": { + "ListRecommendationTemplatesRequest$status": "The status of the action.
" + } + }, + "RemoveDraftAppVersionResourceMappingsRequest": { + "base": null, + "refs": { + } + }, + "RemoveDraftAppVersionResourceMappingsResponse": { + "base": null, + "refs": { + } + }, + "RenderRecommendationType": { + "base": null, + "refs": { + "RenderRecommendationTypeList$member": null + } + }, + "RenderRecommendationTypeList": { + "base": null, + "refs": { + "CreateRecommendationTemplateRequest$recommendationTypes": "An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
An array of strings that specify the recommendation template type or types.
The template is an AlarmRecommendation template.
The template is a SopRecommendation template.
The template is a TestRecommendation template.
The resiliency policies for the Resilience Hub applications.
", + "ListSuggestedResiliencyPoliciesResponse$resiliencyPolicies": "The suggested resiliency policies for the Resilience Hub applications.
" + } + }, + "ResiliencyPolicy": { + "base": "Defines a resiliency policy.
", + "refs": { + "AppAssessment$policy": "The resiliency policy.
", + "CreateResiliencyPolicyResponse$policy": "The type of resiliency policy that was created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
", + "DescribeResiliencyPolicyResponse$policy": "Information about the specific resiliency policy, returned as an object. This object includes creation time, data location constraints, its name, description, tags, the recovery time objective (RTO) and recovery point objective (RPO) in seconds, and more.
", + "ResiliencyPolicies$member": null, + "UpdateResiliencyPolicyResponse$policy": "The type of resiliency policy that was updated, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
" + } + }, + "ResiliencyPolicyTier": { + "base": null, + "refs": { + "CreateResiliencyPolicyRequest$tier": "The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
The overall resiliency score, returned as an object that includes the disruption score and outage score.
", + "refs": { + "AppAssessment$resiliencyScore": "The current resiliency score for the application.
", + "AppComponentCompliance$resiliencyScore": "The current resiliency score for the application.
" + } + }, + "ResolveAppVersionResourcesRequest": { + "base": null, + "refs": { + } + }, + "ResolveAppVersionResourcesResponse": { + "base": null, + "refs": { + } + }, + "ResourceId": { + "base": null, + "refs": { + "ConflictException$resourceId": "The identifier of the resource that the exception applies to.
", + "ResourceNotFoundException$resourceId": "The identifier of the resource that the exception applies to.
" + } + }, + "ResourceImportStatusType": { + "base": null, + "refs": { + "DescribeDraftAppVersionResourcesImportStatusResponse$status": "The status of the action.
", + "ImportResourcesToDraftAppVersionResponse$status": "The status of the action.
" + } + }, + "ResourceMapping": { + "base": "Defines a resource mapping.
", + "refs": { + "ResourceMappingList$member": null + } + }, + "ResourceMappingList": { + "base": null, + "refs": { + "AddDraftAppVersionResourceMappingsRequest$resourceMappings": " Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Mappings used to map logical resources from the template to physical resources. You can use the mapping type CFN_STACK if the application template uses a logical stack name. Or you can map individual resources by using the mapping type RESOURCE. We recommend using the mapping type CFN_STACK if the application is backed by a CloudFormation stack.
Specifies the type of resource mapping.
The resource is mapped to another application. The name of the application is contained in the appRegistryAppName property.
The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the logicalStackName property.
The resource is mapped to another resource. The name of the resource is contained in the resourceName property.
The resource is mapped to a resource group. The name of the resource group is contained in the resourceGroupName property.
The specified resource could not be found.
", + "refs": { + } + }, + "ResourceResolutionStatusType": { + "base": null, + "refs": { + "DescribeAppVersionResourcesResolutionStatusResponse$status": "The status of the action.
", + "ResolveAppVersionResourcesResponse$status": "The status of the action.
" + } + }, + "ResourceType": { + "base": null, + "refs": { + "ConflictException$resourceType": "The type of the resource that the exception applies to.
", + "ResourceNotFoundException$resourceType": "The type of the resource that the exception applies to.
" + } + }, + "RetryAfterSeconds": { + "base": null, + "refs": { + "ThrottlingException$retryAfterSeconds": "The number of seconds to wait before retrying the operation.
" + } + }, + "S3Location": { + "base": "The location of the Amazon S3 bucket.
", + "refs": { + "RecommendationTemplate$templatesLocation": "The file location of the template.
" + } + }, + "Seconds": { + "base": null, + "refs": { + "DisruptionCompliance$achievableRpoInSecs": "The Recovery Point Objective (RPO) that is achievable, in seconds.
", + "DisruptionCompliance$achievableRtoInSecs": "The Recovery Time Objective (RTO) that is achievable, in seconds
", + "DisruptionCompliance$currentRpoInSecs": "The current RPO, in seconds.
", + "DisruptionCompliance$currentRtoInSecs": "The current RTO, in seconds.
", + "FailurePolicy$rpoInSecs": "The Recovery Point Objective (RPO), in seconds.
", + "FailurePolicy$rtoInSecs": "The Recovery Time Objective (RTO), in seconds.
", + "RecommendationDisruptionCompliance$expectedRpoInSecs": "The expected RPO after applying the recommended configuration change.
", + "RecommendationDisruptionCompliance$expectedRtoInSecs": "The expected RTO after applying the recommended configuration change.
" + } + }, + "ServiceQuotaExceededException": { + "base": "You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", + "refs": { + } + }, + "SopRecommendation": { + "base": "Defines a standard operating procedure (SOP) recommendation.
", + "refs": { + "SopRecommendationList$member": null + } + }, + "SopRecommendationList": { + "base": null, + "refs": { + "ListSopRecommendationsResponse$sopRecommendations": "The standard operating procedure (SOP) recommendations for the Resilience Hub applications.
" + } + }, + "SopServiceType": { + "base": null, + "refs": { + "SopRecommendation$serviceType": "The service type.
" + } + }, + "SpecReferenceId": { + "base": null, + "refs": { + "AlarmRecommendation$referenceId": "The reference identifier of the alarm recommendation.
", + "ConfigRecommendation$referenceId": "The reference identifier for the recommendation configuration.
", + "SopRecommendation$referenceId": "The reference identifier for the SOP recommendation.
", + "TestRecommendation$referenceId": "The reference identifier for the test recommendation.
" + } + }, + "StartAppAssessmentRequest": { + "base": null, + "refs": { + } + }, + "StartAppAssessmentResponse": { + "base": null, + "refs": { + } + }, + "String255": { + "base": null, + "refs": { + "AppComponent$name": "The name of the application component.
", + "AppComponent$type": "The type of application component.
", + "DescribeAppVersionResourcesResolutionStatusRequest$resolutionId": "The identifier for a specific resolution.
", + "DescribeAppVersionResourcesResolutionStatusResponse$resolutionId": "The identifier for a specific resolution.
", + "ListAppVersionResourcesRequest$resolutionId": "The identifier for a specific resolution.
", + "ListAppVersionResourcesResponse$resolutionId": "The identifier for a specific resolution.
", + "ListUnsupportedAppVersionResourcesRequest$resolutionId": "The identifier for a specific resolution.
", + "ListUnsupportedAppVersionResourcesResponse$resolutionId": "The identifier for a specific resolution.
", + "LogicalResourceId$identifier": "The identifier of the resource.
", + "LogicalResourceId$logicalStackName": "The name of the CloudFormation stack this resource belongs to.
", + "PhysicalResource$resourceType": "The type of resource.
", + "PhysicalResourceId$identifier": "The identifier of the physical resource.
", + "ResolveAppVersionResourcesResponse$resolutionId": "The identifier for a specific resolution.
", + "ResourceMapping$logicalStackName": "The name of the CloudFormation stack this resource is mapped to.
", + "String255List$member": null, + "UnsupportedResource$resourceType": "The type of resource.
" + } + }, + "String255List": { + "base": null, + "refs": { + "RemoveDraftAppVersionResourceMappingsRequest$logicalStackNames": "The names of the CloudFormation stacks to remove from the resource mappings.
" + } + }, + "String500": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "AlarmRecommendation$name": "The name of the alarm recommendation.
", + "AlarmRecommendation$prerequisite": "The prerequisite for the alarm recommendation.
", + "AppAssessment$message": "Error or warning message from the assessment execution
", + "AppAssessmentSummary$message": "The message from the assessment run.
", + "AppComponentCompliance$message": "The compliance message.
", + "ConflictException$message": null, + "DescribeAppVersionResourcesResolutionStatusResponse$errorMessage": "The returned error message for the request.
", + "DescribeDraftAppVersionResourcesImportStatusResponse$errorMessage": "The returned error message for the request.
", + "DisruptionCompliance$message": "The disruption compliance message.
", + "DisruptionCompliance$rpoDescription": "The RPO description.
", + "DisruptionCompliance$rpoReferenceId": "The RPO reference identifier.
", + "DisruptionCompliance$rtoDescription": "The RTO description.
", + "DisruptionCompliance$rtoReferenceId": "The RTO reference identifier.
", + "InternalServerException$message": null, + "RecommendationDisruptionCompliance$expectedRpoDescription": "The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.
", + "RecommendationDisruptionCompliance$expectedRtoDescription": "The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.
", + "RecommendationItem$resourceId": "The resource identifier.
", + "RecommendationTemplate$message": "The message for the recommendation template.
", + "ResourceNotFoundException$message": null, + "S3Location$bucket": "The name of the Amazon S3 bucket.
", + "S3Location$prefix": "The prefix for the Amazon S3 bucket.
", + "ServiceQuotaExceededException$message": null, + "SopRecommendation$description": "The description of the SOP recommendation.
", + "SopRecommendation$prerequisite": "The prerequisite for the SOP recommendation.
", + "TestRecommendation$description": "The description for the test recommendation.
", + "TestRecommendation$prerequisite": "The prerequisite of the test recommendation.
", + "ThrottlingException$message": null, + "ValidationException$message": null + } + }, + "SuggestedChangesList": { + "base": null, + "refs": { + "ConfigRecommendation$suggestedChanges": "List of the suggested configuration changes.
" + } + }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "The keys of the tags to remove.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "App$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "AppAssessment$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateAppRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateRecommendationTemplateRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "CreateResiliencyPolicyRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "ListTagsForResourceResponse$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "RecommendationTemplate$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "ResiliencyPolicy$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "StartAppAssessmentRequest$tags": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
", + "TagResourceRequest$tags": "The tags to assign to the resource. Each tag consists of a key/value pair.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "TemplateFormat": { + "base": null, + "refs": { + "CreateRecommendationTemplateRequest$format": "The format for the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
The format of the recommendation template.
The template is CloudFormation JSON.
The template is CloudFormation YAML.
Defines a test recommendation.
", + "refs": { + "TestRecommendationList$member": null + } + }, + "TestRecommendationList": { + "base": null, + "refs": { + "ListTestRecommendationsResponse$testRecommendations": "The test recommendations for the Resilience Hub application.
" + } + }, + "TestRisk": { + "base": null, + "refs": { + "TestRecommendation$risk": "The level of risk for this test recommendation.
" + } + }, + "TestType": { + "base": null, + "refs": { + "TestRecommendation$type": "The type of test recommendation.
" + } + }, + "ThrottlingException": { + "base": "The limit on the number of requests per second was exceeded.
", + "refs": { + } + }, + "TimeStamp": { + "base": null, + "refs": { + "App$creationTime": "The timestamp for when the app was created.
", + "App$lastAppComplianceEvaluationTime": "The timestamp for the most recent compliance evaluation.
", + "App$lastResiliencyScoreEvaluationTime": "The timestamp for the most recent resiliency score evaluation.
", + "AppAssessment$endTime": "The end time for the action.
", + "AppAssessment$startTime": "The starting time for the action.
", + "AppAssessmentSummary$endTime": "The end time for the action.
", + "AppAssessmentSummary$startTime": "The starting time for the action.
", + "AppSummary$creationTime": "The timestamp for when the app was created.
", + "DescribeDraftAppVersionResourcesImportStatusResponse$statusChangeTime": "The timestamp for when the status last changed.
", + "RecommendationTemplate$endTime": "The end time for the action.
", + "RecommendationTemplate$startTime": "The start time for the action.
", + "ResiliencyPolicy$creationTime": "The timestamp for when the resiliency policy was created.
" + } + }, + "UnsupportedResource": { + "base": "Defines a resource that is not supported by Resilience Hub.
", + "refs": { + "UnsupportedResourceList$member": null + } + }, + "UnsupportedResourceList": { + "base": null, + "refs": { + "ListUnsupportedAppVersionResourcesResponse$unsupportedResources": "The unsupported resources for the application.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateAppRequest": { + "base": null, + "refs": { + } + }, + "UpdateAppResponse": { + "base": null, + "refs": { + } + }, + "UpdateResiliencyPolicyRequest": { + "base": null, + "refs": { + } + }, + "UpdateResiliencyPolicyResponse": { + "base": null, + "refs": { + } + }, + "Uuid": { + "base": null, + "refs": { + "AlarmRecommendation$recommendationId": "The identifier of the alarm recommendation.
", + "RecommendationIdList$member": null, + "SopRecommendation$recommendationId": "Identifier for the SOP recommendation.
", + "TestRecommendation$recommendationId": "Identifier for the test recommendation.
" + } + }, + "ValidationException": { + "base": "Indicates that a request was not valid.
", + "refs": { + } + } + } +} diff --git a/models/apis/resiliencehub/2020-04-30/examples-1.json b/models/apis/resiliencehub/2020-04-30/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/resiliencehub/2020-04-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/resiliencehub/2020-04-30/paginators-1.json b/models/apis/resiliencehub/2020-04-30/paginators-1.json new file mode 100644 index 00000000000..24cf4c73de6 --- /dev/null +++ b/models/apis/resiliencehub/2020-04-30/paginators-1.json @@ -0,0 +1,74 @@ +{ + "pagination": { + "ListAlarmRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppAssessments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppComponentCompliances": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppComponentRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppVersionResourceMappings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppVersionResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAppVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListApps": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListRecommendationTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListResiliencyPolicies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSopRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListSuggestedResiliencyPolicies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListTestRecommendations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListUnsupportedAppVersionResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/service/backup/api.go b/service/backup/api.go index e8e3b6a8efd..f5a943e7fc8 100644 --- a/service/backup/api.go +++ b/service/backup/api.go @@ -7218,6 +7218,98 @@ func (s *Condition) SetConditionValue(v string) *Condition { return s } +type ConditionParameter struct { + _ struct{} `type:"structure"` + + ConditionKey *string `type:"string"` + + ConditionValue *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConditionParameter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConditionParameter) GoString() string { + return s.String() +} + +// SetConditionKey sets the ConditionKey field's value. +func (s *ConditionParameter) SetConditionKey(v string) *ConditionParameter { + s.ConditionKey = &v + return s +} + +// SetConditionValue sets the ConditionValue field's value. +func (s *ConditionParameter) SetConditionValue(v string) *ConditionParameter { + s.ConditionValue = &v + return s +} + +type Conditions struct { + _ struct{} `type:"structure"` + + StringEquals []*ConditionParameter `type:"list"` + + StringLike []*ConditionParameter `type:"list"` + + StringNotEquals []*ConditionParameter `type:"list"` + + StringNotLike []*ConditionParameter `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Conditions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Conditions) GoString() string { + return s.String() +} + +// SetStringEquals sets the StringEquals field's value. +func (s *Conditions) SetStringEquals(v []*ConditionParameter) *Conditions { + s.StringEquals = v + return s +} + +// SetStringLike sets the StringLike field's value. +func (s *Conditions) SetStringLike(v []*ConditionParameter) *Conditions { + s.StringLike = v + return s +} + +// SetStringNotEquals sets the StringNotEquals field's value. +func (s *Conditions) SetStringNotEquals(v []*ConditionParameter) *Conditions { + s.StringNotEquals = v + return s +} + +// SetStringNotLike sets the StringNotLike field's value. +func (s *Conditions) SetStringNotLike(v []*ConditionParameter) *Conditions { + s.StringNotLike = v + return s +} + // Backup can't perform the action that you requested until it finishes performing // a previous action. Try again later. type ConflictException struct { @@ -16631,6 +16723,8 @@ func (s *RuleInput) SetTargetBackupVaultName(v string) *RuleInput { type Selection struct { _ struct{} `type:"structure"` + Conditions *Conditions `type:"structure"` + // The ARN of the IAM role that Backup uses to authenticate when backing up // the target resource; for example, arn:aws:iam::123456789012:role/S3Access. // @@ -16643,6 +16737,8 @@ type Selection struct { // matching tag. ListOfTags []*Condition `type:"list"` + NotResources []*string `type:"list"` + // An array of strings that contain Amazon Resource Names (ARNs) of resources // to assign to a backup plan. Resources []*string `type:"list"` @@ -16697,6 +16793,12 @@ func (s *Selection) Validate() error { return nil } +// SetConditions sets the Conditions field's value. +func (s *Selection) SetConditions(v *Conditions) *Selection { + s.Conditions = v + return s +} + // SetIamRoleArn sets the IamRoleArn field's value. func (s *Selection) SetIamRoleArn(v string) *Selection { s.IamRoleArn = &v @@ -16709,6 +16811,12 @@ func (s *Selection) SetListOfTags(v []*Condition) *Selection { return s } +// SetNotResources sets the NotResources field's value. +func (s *Selection) SetNotResources(v []*string) *Selection { + s.NotResources = v + return s +} + // SetResources sets the Resources field's value. func (s *Selection) SetResources(v []*string) *Selection { s.Resources = v diff --git a/service/ecs/api.go b/service/ecs/api.go index ac43aa634bd..65e79445cff 100644 --- a/service/ecs/api.go +++ b/service/ecs/api.go @@ -61,10 +61,10 @@ func (c *ECS) CreateCapacityProviderRequest(input *CreateCapacityProviderInput) // Amazon ECS cluster and are used in capacity provider strategies to facilitate // cluster auto scaling. // -// Only capacity providers using an Auto Scaling group can be created. Amazon -// ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers -// which are already created and available to all accounts in Regions supported -// by Fargate. +// Only capacity providers that use an Auto Scaling group can be created. Amazon +// ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. +// These providers are available to all accounts in the Amazon Web Services +// Regions that Fargate supports. // // 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 @@ -78,21 +78,22 @@ func (c *ECS) CreateCapacityProviderRequest(input *CreateCapacityProviderInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * LimitExceededException -// The limit for the resource has been exceeded. +// The limit for the resource was exceeded. // // * UpdateInProgressException -// There is already a current Amazon ECS container agent update in progress -// on the specified container instance. If the container agent becomes disconnected -// while it is in a transitional stage, such as PENDING or STAGING, the update +// There's already a current Amazon ECS container agent update in progress on +// the container instance that's specified. If the container agent becomes disconnected +// while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. // @@ -167,11 +168,11 @@ func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *request.Requ // your own cluster with a unique name with the CreateCluster action. // // When you call the CreateCluster API operation, Amazon ECS attempts to create -// the Amazon ECS service-linked role for your account so that required resources -// in other Amazon Web Services services can be managed on your behalf. However, -// if the IAM user that makes the call does not have permissions to create the -// service-linked role, it is not created. For more information, see Using Service-Linked -// Roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// the Amazon ECS service-linked role for your account. This is so that it can +// manage required resources in other Amazon Web Services services on your behalf. +// However, if the IAM user that makes the call doesn't have permissions to +// create the service-linked role, it isn't created. For more information, see +// Using Service-Linked Roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -186,13 +187,14 @@ func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCluster func (c *ECS) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error) { @@ -260,7 +262,7 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // CreateService API operation for Amazon EC2 Container Service. // -// Runs and maintains a desired number of tasks from a specified task definition. +// Runs and maintains your desired number of tasks from a specified task definition. // If the number of tasks running in a service drops below the desiredCount, // Amazon ECS runs another copy of the task in the specified cluster. To update // an existing service, see the UpdateService action. @@ -271,15 +273,15 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // service. For more information, see Service Load Balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) // in the Amazon Elastic Container Service Developer Guide. // -// Tasks for services that do not use a load balancer are considered healthy -// if they're in the RUNNING state. Tasks for services that do use a load balancer +// Tasks for services that don't use a load balancer are considered healthy +// if they're in the RUNNING state. Tasks for services that use a load balancer // are considered healthy if they're in the RUNNING state and the container // instance that they're hosted on is reported as healthy by the load balancer. // // There are two service scheduler strategies available: // -// * REPLICA - The replica scheduling strategy places and maintains the desired -// number of tasks across your cluster. By default, the service scheduler +// * REPLICA - The replica scheduling strategy places and maintains your +// desired number of tasks across your cluster. By default, the service scheduler // spreads tasks across Availability Zones. You can use task placement strategies // and constraints to customize task placement decisions. For more information, // see Service Scheduler Concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) @@ -288,54 +290,55 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // * DAEMON - The daemon scheduling strategy deploys exactly one task on // each active container instance that meets all of the task placement constraints // that you specify in your cluster. The service scheduler also evaluates -// the task placement constraints for running tasks and will stop tasks that -// do not meet the placement constraints. When using this strategy, you don't -// need to specify a desired number of tasks, a task placement strategy, +// the task placement constraints for running tasks. It also stops tasks +// that don't meet the placement constraints. When using this strategy, you +// don't need to specify a desired number of tasks, a task placement strategy, // or use Service Auto Scaling policies. For more information, see Service // Scheduler Concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) // in the Amazon Elastic Container Service Developer Guide. // // You can optionally specify a deployment configuration for your service. The -// deployment is triggered by changing properties, such as the task definition -// or the desired count of a service, with an UpdateService operation. The default -// value for a replica service for minimumHealthyPercent is 100%. The default -// value for a daemon service for minimumHealthyPercent is 0%. -// -// If a service is using the ECS deployment controller, the minimum healthy -// percent represents a lower limit on the number of tasks in a service that -// must remain in the RUNNING state during a deployment, as a percentage of -// the desired number of tasks (rounded up to the nearest integer), and while -// any container instances are in the DRAINING state if the service contains -// tasks using the EC2 launch type. This parameter enables you to deploy without -// using additional cluster capacity. For example, if your service has a desired -// number of four tasks and a minimum healthy percent of 50%, the scheduler -// might stop two existing tasks to free up cluster capacity before starting -// two new tasks. Tasks for services that do not use a load balancer are considered -// healthy if they're in the RUNNING state. Tasks for services that do use a -// load balancer are considered healthy if they're in the RUNNING state and -// they're reported as healthy by the load balancer. The default value for minimum -// healthy percent is 100%. -// -// If a service is using the ECS deployment controller, the maximum percent -// parameter represents an upper limit on the number of tasks in a service that -// are allowed in the RUNNING or PENDING state during a deployment, as a percentage -// of the desired number of tasks (rounded down to the nearest integer), and -// while any container instances are in the DRAINING state if the service contains -// tasks using the EC2 launch type. This parameter enables you to define the -// deployment batch size. For example, if your service has a desired number -// of four tasks and a maximum percent value of 200%, the scheduler may start -// four new tasks before stopping the four older tasks (provided that the cluster -// resources required to do this are available). The default value for maximum -// percent is 200%. -// -// If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller +// deployment is initiated by changing properties. For example, the deployment +// might be initiated by the task definition or by your desired count of a service. +// This is done with an UpdateService operation. The default value for a replica +// service for minimumHealthyPercent is 100%. The default value for a daemon +// service for minimumHealthyPercent is 0%. +// +// If a service uses the ECS deployment controller, the minimum healthy percent +// represents a lower limit on the number of tasks in a service that must remain +// in the RUNNING state during a deployment. Specifically, it represents it +// as a percentage of your desired number of tasks (rounded up to the nearest +// integer). This happens when any of your container instances are in the DRAINING +// state if the service contains tasks using the EC2 launch type. Using this +// parameter, you can deploy without using additional cluster capacity. For +// example, if you set your service to have desired number of four tasks and +// a minimum healthy percent of 50%, the scheduler might stop two existing tasks +// to free up cluster capacity before starting two new tasks. If they're in +// the RUNNING state, tasks for services that don't use a load balancer are +// considered healthy . If they're in the RUNNING state and reported as healthy +// by the load balancer, tasks for services that do use a load balancer are +// considered healthy . The default value for minimum healthy percent is 100%. +// +// If a service uses the ECS deployment controller, the maximum percent parameter +// represents an upper limit on the number of tasks in a service that are allowed +// in the RUNNING or PENDING state during a deployment. Specifically, it represents +// it as a percentage of the desired number of tasks (rounded down to the nearest +// integer). This happens when any of your container instances are in the DRAINING +// state if the service contains tasks using the EC2 launch type. Using this +// parameter, you can define the deployment batch size. For example, if your +// service has a desired number of four tasks and a maximum percent value of +// 200%, the scheduler may start four new tasks before stopping the four older +// tasks (provided that the cluster resources required to do this are available). +// The default value for maximum percent is 200%. +// +// If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller // types and tasks that use the EC2 launch type, the minimum healthy percent // and maximum percent values are used only to define the lower and upper limit -// on the number of the tasks in the service that remain in the RUNNING state -// while the container instances are in the DRAINING state. If the tasks in -// the service use the Fargate launch type, the minimum healthy percent and -// maximum percent values aren't used, although they're currently visible when -// describing your service. +// on the number of the tasks in the service that remain in the RUNNING state. +// This is while the container instances are in the DRAINING state. If the tasks +// in the service use the Fargate launch type, the minimum healthy percent and +// maximum percent values aren't used. This is the case even if they're currently +// visible when describing your service. // // When creating a service that uses the EXTERNAL deployment controller, you // can specify only parameters that aren't controlled at the task set level. @@ -348,19 +351,20 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // in your cluster using the following logic: // // * Determine which of the container instances in your cluster can support -// your service's task definition (for example, they have the required CPU, -// memory, ports, and container instance attributes). +// the task definition of your service. For example, they have the required +// CPU, memory, ports, and container instance attributes. // // * By default, the service scheduler attempts to balance tasks across Availability -// Zones in this manner (although you can choose a different placement strategy) -// with the placementStrategy parameter): Sort the valid container instances, -// giving priority to instances that have the fewest number of running tasks -// for this service in their respective Availability Zone. For example, if -// zone A has one running service task and zones B and C each have zero, -// valid container instances in either zone B or C are considered optimal -// for placement. Place the new service task on a valid container instance -// in an optimal Availability Zone (based on the previous steps), favoring -// container instances with the fewest number of running tasks for this service. +// Zones in this manner. This is the case even if you can choose a different +// placement strategy with the placementStrategy parameter. Sort the valid +// container instances, giving priority to instances that have the fewest +// number of running tasks for this service in their respective Availability +// Zone. For example, if zone A has one running service task and zones B +// and C each have zero, valid container instances in either zone B or C +// are considered optimal for placement. Place the new service task on a +// valid container instance in an optimal Availability Zone based on the +// previous steps, favoring container instances with the fewest number of +// running tasks for this service. // // 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 @@ -374,30 +378,31 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * PlatformUnknownException -// The specified platform version does not exist. +// The specified platform version doesn't exist. // // * PlatformTaskDefinitionIncompatibilityException -// The specified platform version does not satisfy the task definition's required -// capabilities. +// The specified platform version doesn't satisfy the required capabilities +// of the task definition. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService func (c *ECS) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error) { @@ -482,37 +487,38 @@ func (c *ECS) CreateTaskSetRequest(input *CreateTaskSetInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * PlatformUnknownException -// The specified platform version does not exist. +// The specified platform version doesn't exist. // // * PlatformTaskDefinitionIncompatibilityException -// The specified platform version does not satisfy the task definition's required -// capabilities. +// The specified platform version doesn't satisfy the required capabilities +// of the task definition. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSet @@ -596,13 +602,14 @@ func (c *ECS) DeleteAccountSettingRequest(input *DeleteAccountSettingInput) (req // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAccountSetting func (c *ECS) DeleteAccountSetting(input *DeleteAccountSettingInput) (*DeleteAccountSettingOutput, error) { @@ -681,17 +688,17 @@ func (c *ECS) DeleteAttributesRequest(input *DeleteAttributesInput) (req *reques // // Returned Error Types: // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * TargetNotFoundException -// The specified target could not be found. You can view your available container +// The specified target wasn't found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are // cluster-specific and Region-specific. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributes func (c *ECS) DeleteAttributes(input *DeleteAttributesInput) (*DeleteAttributesOutput, error) { @@ -761,7 +768,7 @@ func (c *ECS) DeleteCapacityProviderRequest(input *DeleteCapacityProviderInput) // // Deletes the specified capacity provider. // -// The FARGATE and FARGATE_SPOT capacity providers are reserved and cannot be +// The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be // deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders // API or by deleting the cluster. // @@ -771,8 +778,8 @@ func (c *ECS) DeleteCapacityProviderRequest(input *DeleteCapacityProviderInput) // strategy. When updating a service, the forceNewDeployment option can be used // to ensure that any tasks using the Amazon EC2 instance capacity provided // by the capacity provider are transitioned to use the capacity from the remaining -// capacity providers. Only capacity providers that are not associated with -// a cluster can be deleted. To remove a capacity provider from a cluster, you +// capacity providers. Only capacity providers that aren't associated with a +// cluster can be deleted. To remove a capacity provider from a cluster, you // can either use PutClusterCapacityProviders or delete the cluster. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -787,13 +794,14 @@ func (c *ECS) DeleteCapacityProviderRequest(input *DeleteCapacityProviderInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCapacityProvider func (c *ECS) DeleteCapacityProvider(input *DeleteCapacityProviderInput) (*DeleteCapacityProviderOutput, error) { @@ -861,10 +869,10 @@ func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Requ // DeleteCluster API operation for Amazon EC2 Container Service. // -// Deletes the specified cluster. The cluster will transition to the INACTIVE -// state. Clusters with an INACTIVE status may remain discoverable in your account +// Deletes the specified cluster. The cluster transitions to the INACTIVE state. +// Clusters with an INACTIVE status might remain discoverable in your account // for a period of time. However, this behavior is subject to change in the -// future, so you should not rely on INACTIVE clusters persisting. +// future. We don't recommend that you rely on INACTIVE clusters persisting. // // You must deregister all container instances from this cluster before you // may delete it. You can list the container instances in a cluster with ListContainerInstances @@ -882,35 +890,36 @@ func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ClusterContainsContainerInstancesException -// You cannot delete a cluster that has registered container instances. First, +// You can't delete a cluster that has registered container instances. First, // deregister the container instances before you can delete the cluster. For // more information, see DeregisterContainerInstance. // // * ClusterContainsServicesException -// You cannot delete a cluster that contains services. First, update the service -// to reduce its desired task count to 0 and then delete the service. For more +// You can't delete a cluster that contains services. First, update the service +// to reduce its desired task count to 0, and then delete the service. For more // information, see UpdateService and DeleteService. // // * ClusterContainsTasksException -// You cannot delete a cluster that has active tasks. +// You can't delete a cluster that has active tasks. // // * UpdateInProgressException -// There is already a current Amazon ECS container agent update in progress -// on the specified container instance. If the container agent becomes disconnected -// while it is in a transitional stage, such as PENDING or STAGING, the update +// There's already a current Amazon ECS container agent update in progress on +// the container instance that's specified. If the container agent becomes disconnected +// while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. // @@ -982,7 +991,7 @@ func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Requ // // Deletes a specified service within a cluster. You can delete a service if // you have no running tasks in it and the desired task count is zero. If the -// service is actively maintaining tasks, you cannot delete it, and you must +// service is actively maintaining tasks, you can't delete it, and you must // update the service to a desired task count of zero. For more information, // see UpdateService. // @@ -1011,21 +1020,22 @@ func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService func (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error) { @@ -1110,36 +1120,37 @@ func (c *ECS) DeleteTaskSetRequest(input *DeleteTaskSetInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // * TaskSetNotFoundException -// The specified task set could not be found. You can view your available task -// sets with DescribeTaskSets. Task sets are specific to each cluster, service -// and Region. +// The specified task set wasn't found. You can view your available task sets +// with DescribeTaskSets. Task sets are specific to each cluster, service and +// Region. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteTaskSet func (c *ECS) DeleteTaskSet(input *DeleteTaskSetInput) (*DeleteTaskSetOutput, error) { @@ -1211,17 +1222,17 @@ func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInsta // This instance is no longer available to run tasks. // // If you intend to use the container instance for some other purpose after -// deregistration, you should stop all of the tasks running on the container -// instance before deregistration. That prevents any orphaned tasks from consuming -// resources. +// deregistration, we recommend that you stop all of the tasks running on the +// container instance before deregistration. That prevents any orphaned tasks +// from consuming resources. // // Deregistering a container instance removes the instance from a cluster, but -// it does not terminate the EC2 instance. If you are finished using the instance, +// it doesn't terminate the EC2 instance. If you are finished using the instance, // be sure to terminate it in the Amazon EC2 console to stop billing. // // If you terminate a running container instance, Amazon ECS automatically deregisters // the instance from your cluster (stopped container instances or instances -// with disconnected agents are not automatically deregistered when terminated). +// with disconnected agents aren't automatically deregistered when terminated). // // 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 @@ -1235,17 +1246,18 @@ func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInsta // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error) { @@ -1319,15 +1331,15 @@ func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInp // Existing services that reference an INACTIVE task definition can still scale // up or down by modifying the service's desired count. // -// You cannot use an INACTIVE task definition to run new tasks or create new -// services, and you cannot update an existing service to reference an INACTIVE +// You can't use an INACTIVE task definition to run new tasks or create new +// services, and you can't update an existing service to reference an INACTIVE // task definition. However, there may be up to a 10-minute window following // deregistration where these restrictions have not yet taken effect. // // At this time, INACTIVE task definitions remain discoverable in your account -// indefinitely. However, this behavior is subject to change in the future, -// so you should not rely on INACTIVE task definitions persisting beyond the -// lifecycle of any associated tasks and services. +// indefinitely. However, this behavior is subject to change in the future. +// We don't recommend that you rely on INACTIVE task definitions persisting +// beyond the lifecycle of any associated tasks and services. // // 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 @@ -1341,13 +1353,14 @@ func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInp // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (*DeregisterTaskDefinitionOutput, error) { @@ -1429,13 +1442,14 @@ func (c *ECS) DescribeCapacityProvidersRequest(input *DescribeCapacityProvidersI // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeCapacityProviders func (c *ECS) DescribeCapacityProviders(input *DescribeCapacityProvidersInput) (*DescribeCapacityProvidersOutput, error) { @@ -1517,13 +1531,14 @@ func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *reques // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters func (c *ECS) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error) { @@ -1606,17 +1621,18 @@ func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstance // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error) { @@ -1698,17 +1714,18 @@ func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) (req *reques // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices func (c *ECS) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error) { @@ -1795,13 +1812,14 @@ func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinition func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (*DescribeTaskDefinitionOutput, error) { @@ -1886,30 +1904,31 @@ func (c *ECS) DescribeTaskSetsRequest(input *DescribeTaskSetsInput) (req *reques // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSets @@ -1992,17 +2011,18 @@ func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks func (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error) { @@ -2088,9 +2108,10 @@ func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpoint func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (*DiscoverPollEndpointOutput, error) { @@ -2172,24 +2193,25 @@ func (c *ECS) ExecuteCommandRequest(input *ExecuteCommandInput) (req *request.Re // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * TargetNotConnectedException -// The target container is not properly configured with the execute command -// agent or the container is no longer active or running. +// The target container isn't properly configured with the execute command agent +// or the container is no longer active or running. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ExecuteCommand func (c *ECS) ExecuteCommand(input *ExecuteCommandInput) (*ExecuteCommandOutput, error) { @@ -2277,13 +2299,14 @@ func (c *ECS) ListAccountSettingsRequest(input *ListAccountSettingsInput) (req * // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAccountSettings func (c *ECS) ListAccountSettings(input *ListAccountSettingsInput) (*ListAccountSettingsOutput, error) { @@ -2414,8 +2437,8 @@ func (c *ECS) ListAttributesRequest(input *ListAttributesInput) (req *request.Re // a list of attribute objects, one for each attribute on each resource. You // can filter the list of results to a single attribute name to only return // results that have that name. You can also filter the results by attribute -// name and value, for example, to see which container instances in a cluster -// are running a Linux AMI (ecs.os-type=linux). +// name and value. You can do this, for example, to see which container instances +// in a cluster are running a Linux AMI (ecs.os-type=linux). // // 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 @@ -2426,12 +2449,12 @@ func (c *ECS) ListAttributesRequest(input *ListAttributesInput) (req *request.Re // // Returned Error Types: // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes func (c *ECS) ListAttributes(input *ListAttributesInput) (*ListAttributesOutput, error) { @@ -2571,13 +2594,14 @@ func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *request.Reques // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClusters func (c *ECS) ListClusters(input *ListClustersInput) (*ListClustersOutput, error) { @@ -2721,17 +2745,18 @@ func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstances func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (*ListContainerInstancesOutput, error) { @@ -2872,17 +2897,18 @@ func (c *ECS) ListServicesRequest(input *ListServicesInput) (req *request.Reques // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServices func (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error) { @@ -3016,17 +3042,18 @@ func (c *ECS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTagsForResource func (c *ECS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { @@ -3100,11 +3127,11 @@ func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamilie // ListTaskDefinitionFamilies API operation for Amazon EC2 Container Service. // -// Returns a list of task definition families that are registered to your account -// (which may include task definition families that no longer have any ACTIVE -// task definition revisions). +// Returns a list of task definition families that are registered to your account. +// This list includes task definition families that no longer have any ACTIVE +// task definition revisions. // -// You can filter out task definition families that do not contain any ACTIVE +// You can filter out task definition families that don't contain any ACTIVE // task definition revisions by setting the status parameter to ACTIVE. You // can also filter the results with the familyPrefix parameter. // @@ -3120,13 +3147,14 @@ func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamilie // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamilies func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (*ListTaskDefinitionFamiliesOutput, error) { @@ -3268,13 +3296,14 @@ func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req * // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitions func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (*ListTaskDefinitionsOutput, error) { @@ -3419,21 +3448,22 @@ func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *request.Request, out // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasks func (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error) { @@ -3556,9 +3586,8 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // Modifies an account setting. Account settings are set on a per-Region basis. // // If you change the account setting for the root user, the default settings -// for all of the IAM users and roles for which no individual account setting -// has been specified are reset. For more information, see Account Settings -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html) +// for all of the IAM users and roles that no individual account setting was +// specified are reset for. For more information, see Account Settings (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html) // in the Amazon Elastic Container Service Developer Guide. // // When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat @@ -3566,9 +3595,9 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // resource type for a specified IAM user, IAM role, or the root user for an // account is affected. The opt-in and opt-out account setting must be set for // each Amazon ECS resource separately. The ARN and resource ID format of a -// resource will be defined by the opt-in status of the IAM user or role that -// created the resource. You must enable this setting to use Amazon ECS features -// such as resource tagging. +// resource is defined by the opt-in status of the IAM user or role that created +// the resource. You must enable this setting to use Amazon ECS features such +// as resource tagging. // // When awsvpcTrunking is specified, the elastic network interface (ENI) limit // for any new container instances that support the feature is changed. If awsvpcTrunking @@ -3596,13 +3625,14 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSetting func (c *ECS) PutAccountSetting(input *PutAccountSettingInput) (*PutAccountSettingOutput, error) { @@ -3686,13 +3716,14 @@ func (c *ECS) PutAccountSettingDefaultRequest(input *PutAccountSettingDefaultInp // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSettingDefault func (c *ECS) PutAccountSettingDefault(input *PutAccountSettingDefaultInput) (*PutAccountSettingDefaultOutput, error) { @@ -3761,7 +3792,7 @@ func (c *ECS) PutAttributesRequest(input *PutAttributesInput) (req *request.Requ // PutAttributes API operation for Amazon EC2 Container Service. // // Create or update an attribute on an Amazon ECS resource. If the attribute -// does not exist, it is created. If the attribute exists, its value is replaced +// doesn't exist, it's created. If the attribute exists, its value is replaced // with the specified value. To delete an attribute, use DeleteAttributes. For // more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. @@ -3775,22 +3806,22 @@ func (c *ECS) PutAttributesRequest(input *PutAttributesInput) (req *request.Requ // // Returned Error Types: // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * TargetNotFoundException -// The specified target could not be found. You can view your available container +// The specified target wasn't found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are // cluster-specific and Region-specific. // // * AttributeLimitExceededException -// You can apply up to 10 custom attributes per resource. You can view the attributes -// of a resource with ListAttributes. You can remove existing attributes on -// a resource with DeleteAttributes. +// You can apply up to 10 custom attributes for each resource. You can view +// the attributes of a resource with ListAttributes. You can remove existing +// attributes on a resource with DeleteAttributes. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributes func (c *ECS) PutAttributes(input *PutAttributesInput) (*PutAttributesOutput, error) { @@ -3865,16 +3896,16 @@ func (c *ECS) PutClusterCapacityProvidersRequest(input *PutClusterCapacityProvid // provider strategy for the cluster. If the specified cluster has existing // capacity providers associated with it, you must specify all existing capacity // providers in addition to any new ones you want to add. Any existing capacity -// providers associated with a cluster that are omitted from a PutClusterCapacityProviders +// providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders // API call will be disassociated with the cluster. You can only disassociate // an existing capacity provider from a cluster if it's not being used by any // existing tasks. // // When creating a service or running a task on a cluster, if no capacity provider // or launch type is specified, then the cluster's default capacity provider -// strategy is used. It is recommended to define a default capacity provider -// strategy for your cluster, however you may specify an empty array ([]) to -// bypass defining a default strategy. +// strategy is used. We recommend that you define a default capacity provider +// strategy for your cluster. However, you must specify an empty array ([]) +// to bypass defining a default strategy. // // 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 @@ -3888,25 +3919,26 @@ func (c *ECS) PutClusterCapacityProvidersRequest(input *PutClusterCapacityProvid // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ResourceInUseException -// The specified resource is in-use and cannot be removed. +// The specified resource is in-use and can't be removed. // // * UpdateInProgressException -// There is already a current Amazon ECS container agent update in progress -// on the specified container instance. If the container agent becomes disconnected -// while it is in a transitional stage, such as PENDING or STAGING, the update +// There's already a current Amazon ECS container agent update in progress on +// the container instance that's specified. If the container agent becomes disconnected +// while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. // @@ -3995,13 +4027,14 @@ func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceI // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (*RegisterContainerInstanceOutput, error) { @@ -4078,8 +4111,8 @@ func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) // You can specify an IAM role for your task with the taskRoleArn parameter. // When you specify an IAM role for a task, its containers can then use the // latest versions of the CLI or SDKs to make API requests to the Amazon Web -// Services services that are specified in the IAM policy associated with the -// role. For more information, see IAM Roles for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) +// Services services that are specified in the IAM policy that's associated +// with the role. 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. // // You can specify a Docker networking mode for the containers in your task @@ -4103,13 +4136,14 @@ func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinition func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (*RegisterTaskDefinitionOutput, error) { @@ -4187,11 +4221,12 @@ func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output // Alternatively, you can use StartTask to use your own scheduler or place tasks // manually on specific container instances. // -// The Amazon ECS API follows an eventual consistency model, due to the distributed -// nature of the system supporting the API. This means that the result of an -// API command you run that affects your Amazon ECS resources might not be immediately -// visible to all subsequent commands you run. Keep this in mind when you carry -// out an API command that immediately follows a previous API command. +// The Amazon ECS API follows an eventual consistency model. This is because +// the distributed nature of the system supporting the API. This means that +// the result of an API command you run that affects your Amazon ECS resources +// might not be immediately visible to all subsequent commands you run. Keep +// this in mind when you carry out an API command that immediately follows a +// previous API command. // // To manage eventual consistency, you can do the following: // @@ -4219,34 +4254,35 @@ func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * PlatformUnknownException -// The specified platform version does not exist. +// The specified platform version doesn't exist. // // * PlatformTaskDefinitionIncompatibilityException -// The specified platform version does not satisfy the task definition's required -// capabilities. +// The specified platform version doesn't satisfy the required capabilities +// of the task definition. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * BlockedException -// Your Amazon Web Services account has been blocked. For more information, -// contact Amazon Web Services Support (http://aws.amazon.com/contact-us/). +// Your Amazon Web Services account was blocked. For more information, contact +// Amazon Web Services Support (http://aws.amazon.com/contact-us/). // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask func (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error) { @@ -4333,17 +4369,18 @@ func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *request.Request, out // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask func (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error) { @@ -4437,17 +4474,18 @@ func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, outpu // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask func (c *ECS) StopTask(input *StopTaskInput) (*StopTaskOutput, error) { @@ -4533,16 +4571,17 @@ func (c *ECS) SubmitAttachmentStateChangesRequest(input *SubmitAttachmentStateCh // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitAttachmentStateChanges func (c *ECS) SubmitAttachmentStateChanges(input *SubmitAttachmentStateChangesInput) (*SubmitAttachmentStateChangesOutput, error) { @@ -4628,12 +4667,13 @@ func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChang // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChange func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (*SubmitContainerStateChangeOutput, error) { @@ -4719,16 +4759,17 @@ func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (r // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChange func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (*SubmitTaskStateChangeOutput, error) { @@ -4798,9 +4839,9 @@ func (c *ECS) TagResourceRequest(input *TagResourceInput) (req *request.Request, // TagResource API operation for Amazon EC2 Container Service. // // Associates the specified tags to a resource with the specified resourceArn. -// If existing tags on a resource are not specified in the request parameters, -// they are not changed. When a resource is deleted, the tags associated with -// that resource are deleted as well. +// 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. // // 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 @@ -4814,20 +4855,21 @@ func (c *ECS) TagResourceRequest(input *TagResourceInput) (req *request.Request, // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ResourceNotFoundException -// The specified resource could not be found. +// The specified resource wasn't found. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TagResource func (c *ECS) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { @@ -4910,20 +4952,21 @@ func (c *ECS) UntagResourceRequest(input *UntagResourceInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ResourceNotFoundException -// The specified resource could not be found. +// The specified resource wasn't found. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UntagResource func (c *ECS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { @@ -5005,13 +5048,14 @@ func (c *ECS) UpdateCapacityProviderRequest(input *UpdateCapacityProviderInput) // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCapacityProvider func (c *ECS) UpdateCapacityProvider(input *UpdateCapacityProviderInput) (*UpdateCapacityProviderOutput, error) { @@ -5093,17 +5137,18 @@ func (c *ECS) UpdateClusterRequest(input *UpdateClusterInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateCluster func (c *ECS) UpdateCluster(input *UpdateClusterInput) (*UpdateClusterOutput, error) { @@ -5185,17 +5230,18 @@ func (c *ECS) UpdateClusterSettingsRequest(input *UpdateClusterSettingsInput) (r // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateClusterSettings func (c *ECS) UpdateClusterSettings(input *UpdateClusterSettingsInput) (*UpdateClusterSettingsOutput, error) { @@ -5264,15 +5310,15 @@ func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req // UpdateContainerAgent API operation for Amazon EC2 Container Service. // // Updates the Amazon ECS container agent on a specified container instance. -// Updating the Amazon ECS container agent does not interrupt running tasks -// or services on the container instance. The process for updating the agent -// differs depending on whether your container instance was launched with the -// Amazon ECS-optimized AMI or another operating system. +// Updating the Amazon ECS container agent doesn't interrupt running tasks or +// services on the container instance. The process for updating the agent differs +// depending on whether your container instance was launched with the Amazon +// ECS-optimized AMI or another operating system. // // The UpdateContainerAgent API isn't supported for container instances using // the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container -// agent, you can update the ecs-init package which will update the agent. For -// more information, see Updating the Amazon ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html) +// agent, you can update the ecs-init package. This updates the agent. For more +// information, see Updating the Amazon ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html) // in the Amazon Elastic Container Service Developer Guide. // // The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon @@ -5293,35 +5339,36 @@ func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UpdateInProgressException -// There is already a current Amazon ECS container agent update in progress -// on the specified container instance. If the container agent becomes disconnected -// while it is in a transitional stage, such as PENDING or STAGING, the update +// There's already a current Amazon ECS container agent update in progress on +// the container instance that's specified. If the container agent becomes disconnected +// while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. // // * NoUpdateAvailableException -// There is no update available for this Amazon ECS container agent. This could -// be because the agent is already running the latest version, or it is so old -// that there is no update path to the current version. +// There's no update available for this Amazon ECS container agent. This might +// be because the agent is already running the latest version or because it's +// so old that there's no update path to the current version. // // * MissingVersionException -// Amazon ECS is unable to determine the current version of the Amazon ECS container -// agent on the container instance and does not have enough information to proceed +// Amazon ECS can't determine the current version of the Amazon ECS container +// agent on the container instance and doesn't have enough information to proceed // with an update. This could be because the agent running on the container -// instance is an older or custom version that does not use our version information. +// instance is a previous or custom version that doesn't use our version information. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent func (c *ECS) UpdateContainerAgent(input *UpdateContainerAgentInput) (*UpdateContainerAgentOutput, error) { @@ -5396,7 +5443,7 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // from a cluster, for example to perform system updates, update the Docker // daemon, or scale down the cluster size. // -// A container instance cannot be changed to DRAINING until it has reached an +// A container instance can't be changed to DRAINING until it has reached an // ACTIVE status. If the instance is in any other status, an error will be received. // // When you set a container instance to DRAINING, Amazon ECS prevents new tasks @@ -5416,20 +5463,20 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // before starting two new tasks. If the minimum is 100%, the service scheduler // can't remove existing tasks until the replacement tasks are considered // healthy. Tasks for services that do not use a load balancer are considered -// healthy if they are in the RUNNING state. Tasks for services that use -// a load balancer are considered healthy if they are in the RUNNING state -// and the container instance they are hosted on is reported as healthy by -// the load balancer. +// healthy if they're in the RUNNING state. Tasks for services that use a +// load balancer are considered healthy if they're in the RUNNING state and +// the container instance they're hosted on is reported as healthy by the +// load balancer. // // * The maximumPercent parameter represents an upper limit on the number -// of running tasks during task replacement, which enables you to define -// the replacement batch size. For example, if desiredCount is four tasks, -// a maximum of 200% starts four new tasks before stopping the four tasks -// to be drained, provided that the cluster resources required to do this -// are available. If the maximum is 100%, then replacement tasks can't start +// of running tasks during task replacement. You can use this to define the +// replacement batch size. For example, if desiredCount is four tasks, a +// maximum of 200% starts four new tasks before stopping the four tasks to +// be drained, provided that the cluster resources required to do this are +// available. If the maximum is 100%, then replacement tasks can't start // until the draining tasks have stopped. // -// Any PENDING or RUNNING tasks that do not belong to a service are not affected. +// Any PENDING or RUNNING tasks that do not belong to a service aren't affected. // You must wait for them to finish or stop them manually. // // A container instance has completed draining when it has no more RUNNING tasks. @@ -5451,17 +5498,18 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState func (c *ECS) UpdateContainerInstancesState(input *UpdateContainerInstancesStateInput) (*UpdateContainerInstancesStateOutput, error) { @@ -5546,15 +5594,15 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // the desired count, deployment configuration, task placement constraints and // strategies, and health check grace period can be updated using this API. // If the network configuration, platform version, or task definition need to -// be updated, a new CodeDeploy deployment should be created. For more information, +// be updated, a new CodeDeploy deployment is created. For more information, // see CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) // in the CodeDeploy API Reference. // // For services using an external deployment controller, you can update only // the desired count, task placement constraints and strategies, and health // check grace period using this API. If the launch type, load balancer, network -// configuration, platform version, or task definition need to be updated, you -// should create a new task set. For more information, see CreateTaskSet. +// configuration, platform version, or task definition need to be updated, create +// a new task set. For more information, see CreateTaskSet. // // You can add to or subtract from the number of instantiations of a task definition // in a service by specifying the cluster that the service is running in and @@ -5566,7 +5614,7 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // (in the service's deployment configuration) to determine the deployment strategy. // // If your updated Docker image uses the same tag as what is in the existing -// task definition for your service (for example, my_image:latest), you do not +// task definition for your service (for example, my_image:latest), you don't // need to create a new revision of your task definition. You can update the // service using the forceNewDeployment option. The new tasks launched by the // deployment pull the current image/tag combination from your repository when @@ -5580,40 +5628,41 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // * If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount // temporarily during a deployment. For example, if desiredCount is four // tasks, a minimum of 50% allows the scheduler to stop two existing tasks -// before starting two new tasks. Tasks for services that do not use a load -// balancer are considered healthy if they are in the RUNNING state. Tasks -// for services that use a load balancer are considered healthy if they are -// in the RUNNING state and the container instance they are hosted on is -// reported as healthy by the load balancer. +// before starting two new tasks. Tasks for services that don't use a load +// balancer are considered healthy if they're in the RUNNING state. Tasks +// for services that use a load balancer are considered healthy if they're +// in the RUNNING state and the container instance they're hosted on is reported +// as healthy by the load balancer. // // * The maximumPercent parameter represents an upper limit on the number -// of running tasks during a deployment, which enables you to define the -// deployment batch size. For example, if desiredCount is four tasks, a maximum -// of 200% starts four new tasks before stopping the four older tasks (provided -// that the cluster resources required to do this are available). +// of running tasks during a deployment. You can use it to define the deployment +// batch size. For example, if desiredCount is four tasks, a maximum of 200% +// starts four new tasks before stopping the four older tasks (provided that +// the cluster resources required to do this are available). // // When UpdateService stops a task during a deployment, the equivalent of docker // stop is issued to the containers running in the task. This results in a SIGTERM -// and a 30-second timeout, after which SIGKILL is sent and the containers are +// and a 30-second timeout. After this, SIGKILL is sent and the containers are // forcibly stopped. If the container handles the SIGTERM gracefully and exits // within 30 seconds from receiving it, no SIGKILL is sent. // // When the service scheduler launches new tasks, it determines task placement -// in your cluster with the following logic: +// in your cluster with the following logic. // // * Determine which of the container instances in your cluster can support -// your service's task definition (for example, they have the required CPU, -// memory, ports, and container instance attributes). +// your service's task definition. For example, they have the required CPU, +// memory, ports, and container instance attributes. // // * By default, the service scheduler attempts to balance tasks across Availability -// Zones in this manner (although you can choose a different placement strategy): -// Sort the valid container instances by the fewest number of running tasks -// for this service in the same Availability Zone as the instance. For example, -// if zone A has one running service task and zones B and C each have zero, -// valid container instances in either zone B or C are considered optimal -// for placement. Place the new service task on a valid container instance -// in an optimal Availability Zone (based on the previous steps), favoring -// container instances with the fewest number of running tasks for this service. +// Zones in this manner even though you can choose a different placement +// strategy. Sort the valid container instances by the fewest number of running +// tasks for this service in the same Availability Zone as the instance. +// For example, if zone A has one running service task and zones B and C +// each have zero, valid container instances in either zone B or C are considered +// optimal for placement. Place the new service task on a valid container +// instance in an optimal Availability Zone (based on the previous steps), +// favoring container instances with the fewest number of running tasks for +// this service. // // When the service scheduler stops running tasks, it attempts to maintain balance // across the Availability Zones in your cluster using the following logic: @@ -5639,35 +5688,36 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // * PlatformUnknownException -// The specified platform version does not exist. +// The specified platform version doesn't exist. // // * PlatformTaskDefinitionIncompatibilityException -// The specified platform version does not satisfy the task definition's required -// capabilities. +// The specified platform version doesn't satisfy the required capabilities +// of the task definition. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService func (c *ECS) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error) { @@ -5753,36 +5803,37 @@ func (c *ECS) UpdateServicePrimaryTaskSetRequest(input *UpdateServicePrimaryTask // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // * TaskSetNotFoundException -// The specified task set could not be found. You can view your available task -// sets with DescribeTaskSets. Task sets are specific to each cluster, service -// and Region. +// The specified task set wasn't found. You can view your available task sets +// with DescribeTaskSets. Task sets are specific to each cluster, service and +// Region. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServicePrimaryTaskSet func (c *ECS) UpdateServicePrimaryTaskSet(input *UpdateServicePrimaryTaskSetInput) (*UpdateServicePrimaryTaskSetOutput, error) { @@ -5866,36 +5917,37 @@ func (c *ECS) UpdateTaskSetRequest(input *UpdateTaskSetInput) (req *request.Requ // These errors are usually caused by a server issue. // // * ClientException -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. // // * InvalidParameterException -// The specified parameter is invalid. Review the available parameters for the -// API request. +// The specified parameter isn't valid. Review the available parameters for +// the API request. // // * ClusterNotFoundException -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. // // * UnsupportedFeatureException -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. // // * AccessDeniedException -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. // // * ServiceNotFoundException -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. // // * ServiceNotActiveException -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. // // * TaskSetNotFoundException -// The specified task set could not be found. You can view your available task -// sets with DescribeTaskSets. Task sets are specific to each cluster, service -// and Region. +// The specified task set wasn't found. You can view your available task sets +// with DescribeTaskSets. Task sets are specific to each cluster, service and +// Region. // // See also, https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateTaskSet func (c *ECS) UpdateTaskSet(input *UpdateTaskSetInput) (*UpdateTaskSetOutput, error) { @@ -5919,7 +5971,7 @@ func (c *ECS) UpdateTaskSetWithContext(ctx aws.Context, input *UpdateTaskSetInpu return out, req.Send() } -// You do not have authorization to perform the requested action. +// You don't have authorization to perform the requested action. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6106,16 +6158,16 @@ func (s *AttachmentStateChange) SetStatus(v string) *AttachmentStateChange { return s } -// An attribute is a name-value pair associated with an Amazon ECS object. Attributes -// enable you to extend the Amazon ECS data model by adding custom metadata -// to your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) +// An attribute is a name-value pair that's associated with an Amazon ECS object. +// Attributes enable you to extend the Amazon ECS data model by adding custom +// metadata to your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. type Attribute struct { _ struct{} `type:"structure"` - // The name of the attribute. The name must contain between 1 and 128 characters - // and name may contain letters (uppercase and lowercase), numbers, hyphens, - // underscores, forward slashes, back slashes, or periods. + // The name of the attribute. The name must contain between 1 and 128 characters. + // The name may contain letters (uppercase and lowercase), numbers, hyphens + // (-), underscores (_), forward slashes (/), back slashes (\), or periods (.). // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` @@ -6124,15 +6176,14 @@ type Attribute struct { // the full Amazon Resource Name (ARN). TargetId *string `locationName:"targetId" type:"string"` - // The type of the target with which to attach the attribute. This parameter - // is required if you use the short form ID for a resource instead of the full - // ARN. + // The type of the target to attach the attribute with. This parameter is required + // if you use the short form ID for a resource instead of the full ARN. TargetType *string `locationName:"targetType" type:"string" enum:"TargetType"` - // The value of the attribute. The value must contain between 1 and 128 characters - // and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, - // periods, at signs (@), forward slashes, back slashes, colons, or spaces. - // The value cannot contain any leading or trailing whitespace. + // The value of the attribute. The value must contain between 1 and 128 characters. + // It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores + // (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons + // (:), or spaces. The value can't can't start or end with a space. Value *string `locationName:"value" type:"string"` } @@ -6191,9 +6242,9 @@ func (s *Attribute) SetValue(v string) *Attribute { return s } -// You can apply up to 10 custom attributes per resource. You can view the attributes -// of a resource with ListAttributes. You can remove existing attributes on -// a resource with DeleteAttributes. +// You can apply up to 10 custom attributes for each resource. You can view +// the attributes of a resource with ListAttributes. You can remove existing +// attributes on a resource with DeleteAttributes. type AttributeLimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6274,7 +6325,7 @@ type AutoScalingGroupProvider struct { // termination protection. // // When using managed termination protection, managed scaling must also be used - // otherwise managed termination protection will not work. + // otherwise managed termination protection doesn't work. // // When managed termination protection is enabled, Amazon ECS prevents the Amazon // EC2 instances in an Auto Scaling group that contain tasks from being terminated @@ -6284,7 +6335,7 @@ type AutoScalingGroupProvider struct { // in the Auto Scaling User Guide. // // When managed termination protection is disabled, your Amazon EC2 instances - // are not protected from termination when the Auto Scaling group scales in. + // aren't protected from termination when the Auto Scaling group scales in. ManagedTerminationProtection *string `locationName:"managedTerminationProtection" type:"string" enum:"ManagedTerminationProtection"` } @@ -6354,17 +6405,17 @@ type AutoScalingGroupProviderUpdate struct { // termination protection. // // When using managed termination protection, managed scaling must also be used - // otherwise managed termination protection will not work. + // otherwise managed termination protection doesn't work. // // When managed termination protection is enabled, Amazon ECS prevents the Amazon // EC2 instances in an Auto Scaling group that contain tasks from being terminated // during a scale-in action. The Auto Scaling group and each instance in the - // Auto Scaling group must have instance protection from scale-in actions enabled - // as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) + // Auto Scaling group must have instance protection from scale-in actions enabled. + // For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) // in the Auto Scaling User Guide. // // When managed termination protection is disabled, your Amazon EC2 instances - // are not protected from termination when the Auto Scaling group scales in. + // aren't protected from termination when the Auto Scaling group scales in. ManagedTerminationProtection *string `locationName:"managedTerminationProtection" type:"string" enum:"ManagedTerminationProtection"` } @@ -6422,13 +6473,13 @@ type AwsVpcConfiguration struct { AssignPublicIp *string `locationName:"assignPublicIp" type:"string" enum:"AssignPublicIp"` // The IDs of the security groups associated with the task or service. If you - // do not specify a security group, the default security group for the VPC is - // used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. + // don't specify a security group, the default security group for the VPC is + // used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration. // // All specified security groups must be from the same VPC. SecurityGroups []*string `locationName:"securityGroups" type:"list"` - // The IDs of the subnets associated with the task or service. There is a limit + // The IDs of the subnets associated with the task or service. There's a limit // of 16 subnets that can be specified per AwsVpcConfiguration. // // All specified subnets must be from the same VPC. @@ -6486,8 +6537,8 @@ func (s *AwsVpcConfiguration) SetSubnets(v []*string) *AwsVpcConfiguration { return s } -// Your Amazon Web Services account has been blocked. For more information, -// contact Amazon Web Services Support (http://aws.amazon.com/contact-us/). +// Your Amazon Web Services account was blocked. For more information, contact +// Amazon Web Services Support (http://aws.amazon.com/contact-us/). type BlockedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6551,7 +6602,7 @@ func (s *BlockedException) RequestID() string { return s.RespMetadata.RequestID } -// The details of a capacity provider. +// The details for a capacity provider. type CapacityProvider struct { _ struct{} `type:"structure"` @@ -6566,12 +6617,12 @@ type CapacityProvider struct { // The current status of the capacity provider. Only capacity providers in an // ACTIVE state can be used in a cluster. When a capacity provider is successfully - // deleted, it will have an INACTIVE status. + // deleted, it has an INACTIVE status. Status *string `locationName:"status" type:"string" enum:"CapacityProviderStatus"` // The metadata that you apply to the capacity provider to help you categorize - // and organize it. Each tag consists of a key and an optional value, both of - // which you define. + // and organize it. Each tag consists of a key and an optional value. You define + // both. // // The following basic restrictions apply to tags: // @@ -6598,7 +6649,7 @@ type CapacityProvider struct { Tags []*Tag `locationName:"tags" type:"list"` // The update status of the capacity provider. The following are the possible - // states that will be returned. + // states that is returned. // // DELETE_IN_PROGRESS // @@ -6606,13 +6657,12 @@ type CapacityProvider struct { // // DELETE_COMPLETE // - // The capacity provider has been successfully deleted and will have an INACTIVE - // status. + // The capacity provider was successfully deleted and has an INACTIVE status. // // DELETE_FAILED // - // The capacity provider was unable to be deleted. The update status reason - // will provide further details about why the delete failed. + // The capacity provider can't be deleted. The update status reason provides + // further details about why the delete failed. UpdateStatus *string `locationName:"updateStatus" type:"string" enum:"CapacityProviderUpdateStatus"` // The update status reason. This provides further details about the update @@ -6720,7 +6770,7 @@ type CapacityProviderStrategyItem struct { // If no weight value is specified, the default value of 0 is used. When multiple // capacity providers are specified within a capacity provider strategy, at // least one of the capacity providers must have a weight value greater than - // zero and any capacity providers with a weight of 0 will not be used to place + // zero and any capacity providers with a weight of 0 can't be used to place // tasks. If you specify multiple capacity providers in a strategy that all // have a weight of 0, any RunTask or CreateService actions using the capacity // provider strategy will fail. @@ -6729,8 +6779,8 @@ type CapacityProviderStrategyItem struct { // two capacity providers and both have a weight of 1, then when the base is // satisfied, the tasks will be split evenly across the two capacity providers. // Using that same logic, if you specify a weight of 1 for capacityProviderA - // and a weight of 4 for capacityProviderB, then for every one task that is - // run using capacityProviderA, four tasks would use capacityProviderB. + // and a weight of 4 for capacityProviderB, then for every one task that's run + // using capacityProviderA, four tasks would use capacityProviderB. Weight *int64 `locationName:"weight" type:"integer"` } @@ -6783,9 +6833,10 @@ func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrat return s } -// These errors are usually caused by a client action, such as using an action -// or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that is not valid. +// These errors are usually caused by a client action. This client action might +// be using an action or resource on behalf of a user that doesn't have permissions +// to use the action or resource,. Or, it might be specifying an identifier +// that isn't valid. type ClientException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6849,7 +6900,7 @@ func (s *ClientException) RequestID() string { return s.RespMetadata.RequestID } -// A regional grouping of one or more container instances on which you can run +// A regional grouping of one or more container instances where you can run // task requests. Each account receives a default cluster the first time you // use the Amazon ECS service, but you may also create other clusters. Clusters // may contain more than one instance type simultaneously. @@ -6861,12 +6912,12 @@ type Cluster struct { ActiveServicesCount *int64 `locationName:"activeServicesCount" type:"integer"` // The resources attached to a cluster. When using a capacity provider with - // a cluster, the Auto Scaling plan that is created will be returned as a cluster + // a cluster, the Auto Scaling plan that's created is returned as a cluster // attachment. Attachments []*Attachment `locationName:"attachments" type:"list"` // The status of the capacity providers associated with the cluster. The following - // are the states that will be returned: + // are the states that are returned. // // UPDATE_IN_PROGRESS // @@ -6916,8 +6967,8 @@ type Cluster struct { // Container Insights is enabled or disabled for a cluster. Settings []*ClusterSetting `locationName:"settings" type:"list"` - // Additional information about your clusters that are separated by launch type, - // including: + // Additional information about your clusters that are separated by launch type. + // They include the following: // // * runningEC2TasksCount // @@ -6936,8 +6987,8 @@ type Cluster struct { // * drainingFargateServiceCount Statistics []*KeyValuePair `locationName:"statistics" type:"list"` - // The status of the cluster. The following are the possible states that will - // be returned. + // The status of the cluster. The following are the possible states that are + // returned. // // ACTIVE // @@ -6946,30 +6997,29 @@ type Cluster struct { // // PROVISIONING // - // The cluster has capacity providers associated with it and the resources needed - // for the capacity provider are being created. + // The cluster has capacity providers that are associated with it and the resources + // needed for the capacity provider are being created. // // DEPROVISIONING // - // The cluster has capacity providers associated with it and the resources needed - // for the capacity provider are being deleted. + // The cluster has capacity providers that are associated with it and the resources + // needed for the capacity provider are being deleted. // // FAILED // - // The cluster has capacity providers associated with it and the resources needed - // for the capacity provider have failed to create. + // The cluster has capacity providers that are associated with it and the resources + // needed for the capacity provider have failed to create. // // INACTIVE // // The cluster has been deleted. Clusters with an INACTIVE status may remain // discoverable in your account for a period of time. However, this behavior - // is subject to change in the future, so you should not rely on INACTIVE clusters - // persisting. + // is subject to change in the future. We don't recommend that you rely on INACTIVE + // clusters persisting. Status *string `locationName:"status" type:"string"` // The metadata that you apply to the cluster to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. + // them. Each tag consists of a key and an optional value. You define both. // // The following basic restrictions apply to tags: // @@ -7136,7 +7186,7 @@ func (s *ClusterConfiguration) SetExecuteCommandConfiguration(v *ExecuteCommandC return s } -// You cannot delete a cluster that has registered container instances. First, +// You can't delete a cluster that has registered container instances. First, // deregister the container instances before you can delete the cluster. For // more information, see DeregisterContainerInstance. type ClusterContainsContainerInstancesException struct { @@ -7202,8 +7252,8 @@ func (s *ClusterContainsContainerInstancesException) RequestID() string { return s.RespMetadata.RequestID } -// You cannot delete a cluster that contains services. First, update the service -// to reduce its desired task count to 0 and then delete the service. For more +// You can't delete a cluster that contains services. First, update the service +// to reduce its desired task count to 0, and then delete the service. For more // information, see UpdateService and DeleteService. type ClusterContainsServicesException struct { _ struct{} `type:"structure"` @@ -7268,7 +7318,7 @@ func (s *ClusterContainsServicesException) RequestID() string { return s.RespMetadata.RequestID } -// You cannot delete a cluster that has active tasks. +// You can't delete a cluster that has active tasks. type ClusterContainsTasksException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7332,8 +7382,8 @@ func (s *ClusterContainsTasksException) RequestID() string { return s.RespMetadata.RequestID } -// The specified cluster could not be found. You can view your available clusters -// with ListClusters. Amazon ECS clusters are Region-specific. +// The specified cluster wasn't found. You can view your available clusters +// with ListClusters. Amazon ECS clusters are Region specific. type ClusterNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7443,16 +7493,15 @@ func (s *ClusterSetting) SetValue(v string) *ClusterSetting { return s } -// A Docker container that is part of a task. +// A Docker container that's part of a task. type Container struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the container. ContainerArn *string `locationName:"containerArn" type:"string"` - // The number of CPU units set for the container. The value will be 0 if no - // value was specified in the container definition when the task definition - // was registered. + // The number of CPU units set for the container. The value is 0 if no value + // was specified in the container definition when the task definition was registered. Cpu *string `locationName:"cpu" type:"string"` // The exit code returned from the container. @@ -7461,7 +7510,7 @@ type Container struct { // The IDs of each GPU assigned to the container. GpuIds []*string `locationName:"gpuIds" type:"list"` - // The health status of the container. If health checks are not configured for + // The health status of the container. If health checks aren't configured for // this container in its task definition, then it reports the health status // as UNKNOWN. HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"` @@ -7632,13 +7681,13 @@ func (s *Container) SetTaskArn(v string) *Container { type ContainerDefinition struct { _ struct{} `type:"structure"` - // The command that is passed to the container. This parameter maps to Cmd in + // The command that's passed to the container. This parameter maps to Cmd in // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // For more information, see https://docs.docker.com/engine/reference/builder/#cmd // (https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple - // arguments, each argument should be a separated string in the array. + // arguments, each argument is a separated string in the array. Command []*string `locationName:"command" type:"list"` // The number of cpu units reserved for the container. This parameter maps to @@ -7658,19 +7707,19 @@ type ContainerDefinition struct { // Linux containers share unallocated CPU units with other containers on the // container instance with the same ratio as their allocated amount. For example, // if you run a single-container task on a single-core instance type with 512 - // CPU units specified for that container, and that is the only task running + // CPU units specified for that container, and that's the only task running // on the container instance, that container could use the full 1,024 CPU unit // share at any given time. However, if you launched another copy of the same - // task on that container instance, each task would be guaranteed a minimum - // of 512 CPU units when needed, and each container could float to higher CPU - // usage if the other container was not using it, but if both tasks were 100% - // active all of the time, they would be limited to 512 CPU units. + // task on that container instance, each task is guaranteed a minimum of 512 + // CPU units when needed. Moreover, each container could float to higher CPU + // usage if the other container was not using it. If both tasks were 100% active + // all of the time, they would be limited to 512 CPU units. // // On Linux container instances, the Docker daemon on the container instance // uses the CPU value to calculate the relative CPU share ratios for running // containers. For more information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#cpu-share-constraint) // in the Docker documentation. The minimum valid CPU share value that the Linux - // kernel allows is 2. However, the CPU parameter is not required, and you can + // kernel allows is 2. However, the CPU parameter isn't required, and you can // use CPU values below 2 in your container definitions. For CPU values below // 2 (including null), the behavior varies based on your Amazon ECS container // agent version: @@ -7685,7 +7734,7 @@ type ContainerDefinition struct { // // On Windows container instances, the CPU limit is enforced as an absolute // limit, or a quota. Windows containers only have access to the specified amount - // of CPU that is described in the task definition. A null or zero CPU value + // of CPU that's described in the task definition. A null or zero CPU value // is passed to Docker as 0, which Windows interprets as 1% of one CPU. Cpu *int64 `locationName:"cpu" type:"integer"` @@ -7698,7 +7747,7 @@ type ContainerDefinition struct { // we recommend using the latest container agent version. For information about // checking your agent version and updating to the latest version, see Updating // the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) - // in the Amazon Elastic Container Service Developer Guide. If you are using + // in the Amazon Elastic Container Service Developer Guide. If you're using // an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 // of the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container @@ -7707,7 +7756,7 @@ type ContainerDefinition struct { // in the Amazon Elastic Container Service Developer Guide. // // For tasks using the Fargate launch type, the task or service requires the - // followiwng platforms: + // following platforms: // // * Linux platform version 1.3.0 or later. // @@ -7748,7 +7797,7 @@ type ContainerDefinition struct { DockerLabels map[string]*string `locationName:"dockerLabels" type:"map"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level - // security systems. This field is not valid for containers in tasks using the + // security systems. This field isn't valid for containers in tasks using the // Fargate launch type. // // With Windows containers, this parameter can be used to reference a credential @@ -7775,11 +7824,11 @@ type ContainerDefinition struct { DockerSecurityOptions []*string `locationName:"dockerSecurityOptions" type:"list"` // - // Early versions of the Amazon ECS container agent do not properly handle entryPoint + // Early versions of the Amazon ECS container agent don't properly handle entryPoint // parameters. If you have problems using entryPoint, update your container // agent or enter your commands and arguments as command array items instead. // - // The entry point that is passed to the container. This parameter maps to Entrypoint + // The entry point that's passed to the container. This parameter maps to Entrypoint // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). @@ -7792,39 +7841,39 @@ type ContainerDefinition struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --env option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // We do not recommend using plaintext environment variables for sensitive information, - // such as credential data. + // We don't recommend that you use plaintext environment variables for sensitive + // information, such as credential data. Environment []*KeyValuePair `locationName:"environment" type:"list"` // A list of files containing the environment variables to pass to a container. // This parameter maps to the --env-file option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // // You can specify up to ten environment files. The file must have a .env file - // extension. Each line in an environment file should contain an environment - // variable in VARIABLE=VALUE format. Lines beginning with # are treated as - // comments and are ignored. For more information on the environment variable - // file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/). + // extension. Each line in an environment file contains an environment variable + // in VARIABLE=VALUE format. Lines beginning with # are treated as comments + // and are ignored. For more information about the environment variable file + // syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/). // // If there are environment variables specified using the environment parameter // in a container definition, they take precedence over the variables contained // within an environment file. If multiple environment files are specified that - // contain the same variable, they are processed from the top down. It is recommended - // to use unique variable names. For more information, see Specifying Environment - // Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) + // contain the same variable, they're processed from the top down. We recommend + // that you use unique variable names. For more information, see Specifying + // Environment Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. EnvironmentFiles []*EnvironmentFile `locationName:"environmentFiles" type:"list"` // If the essential parameter of a container is marked as true, and that container // fails or stops for any reason, all other containers that are part of the // task are stopped. If the essential parameter of a container is marked as - // false, then its failure does not affect the rest of the containers in a task. - // If this parameter is omitted, a container is assumed to be essential. + // false, its failure doesn't affect the rest of the containers in a task. If + // this parameter is omitted, a container is assumed to be essential. // // All tasks must have at least one essential container. If you have an application - // that is composed of multiple containers, you should group containers that - // are used for a common purpose into components, and separate the different - // components into multiple task definitions. For more information, see Application - // Architecture (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) + // that's composed of multiple containers, group containers that are used for + // a common purpose into components, and separate the different components into + // multiple task definitions. For more information, see Application Architecture + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) // in the Amazon Elastic Container Service Developer Guide. Essential *bool `locationName:"essential" type:"boolean"` @@ -7834,8 +7883,8 @@ type ContainerDefinition struct { // of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and // the --add-host option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // This parameter is not supported for Windows containers or tasks that use - // the awsvpc network mode. + // This parameter isn't supported for Windows containers or tasks that use the + // awsvpc network mode. ExtraHosts []*HostEntry `locationName:"extraHosts" type:"list"` // The FireLens configuration for the container. This is used to specify and @@ -7856,12 +7905,12 @@ type ContainerDefinition struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // The hostname parameter is not supported if you are using the awsvpc network + // The hostname parameter is not supported if you're using the awsvpc network // mode. Hostname *string `locationName:"hostname" type:"string"` // 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. + // Docker daemon. By default, images in the Docker Hub registry are available. // Other repositories are specified with either repository-url/image:tag or // repository-url/image@digest . Up to 255 letters (uppercase and lowercase), // numbers, hyphens, underscores, colons, periods, forward slashes, and number @@ -7872,7 +7921,7 @@ type ContainerDefinition struct { // // * When a new task starts, the Amazon ECS container agent pulls the latest // version of the specified image and tag for the container to use. However, - // subsequent updates to a repository image are not propagated to already + // subsequent updates to a repository image aren't propagated to already // running tasks. // // * Images in Amazon ECR repositories can be specified by either using the @@ -7890,8 +7939,8 @@ type ContainerDefinition struct { // name (for example, quay.io/assemblyline/ubuntu). Image *string `locationName:"image" type:"string"` - // When this parameter is true, this allows you to deploy containerized applications - // that require stdin or a tty to be allocated. This parameter maps to OpenStdin + // When this parameter is true, you can deploy containerized applications that + // require stdin or a tty to be allocated. This parameter maps to OpenStdin // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --interactive option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). @@ -7928,11 +7977,11 @@ type ContainerDefinition struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // By default, containers use the same logging driver that the Docker daemon - // uses. However the container may use a different logging driver than the Docker + // uses. However the container can 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 + // for remote logging options). For more information about the options for different // supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) // in the Docker documentation. // @@ -7967,11 +8016,12 @@ type ContainerDefinition struct { // value or a container-level memory value. If you specify both a container-level // memory and memoryReservation value, memory must be greater than memoryReservation. // If you specify memoryReservation, then that value is subtracted from the - // available memory resources for the container instance on which the container + // available memory resources for the container instance where the container // is placed. Otherwise, the value of memory is used. // - // The Docker daemon reserves a minimum of 4 MiB of memory for a container, - // so you should not specify fewer than 4 MiB of memory for your containers. + // The Docker daemon reserves a minimum of 4 MiB of memory for a container. + // Therefore, we recommend that you specify fewer than 4 MiB of memory for your + // containers. Memory *int64 `locationName:"memory" type:"integer"` // The soft limit (in MiB) of memory to reserve for the container. When system @@ -7988,7 +8038,7 @@ type ContainerDefinition struct { // integer for one or both of memory or memoryReservation in a container definition. // If you specify both, memory must be greater than memoryReservation. If you // specify memoryReservation, then that value is subtracted from the available - // memory resources for the container instance on which the container is placed. + // memory resources for the container instance where the container is placed. // Otherwise, the value of memory is used. // // For example, if your container normally uses 128 MiB of memory, but occasionally @@ -7998,8 +8048,9 @@ type ContainerDefinition struct { // resources on the container instance, but also allow the container to consume // more memory resources when needed. // - // The Docker daemon reserves a minimum of 4 MiB of memory for a container, - // so you should not specify fewer than 4 MiB of memory for your containers. + // The Docker daemon reserves a minimum of 4 MiB of memory for a container. + // Therefore, we recommend that you specify fewer than 4 MiB of memory for your + // containers. MemoryReservation *int64 `locationName:"memoryReservation" type:"integer"` // The mount points for data volumes in your container. @@ -8009,12 +8060,12 @@ type ContainerDefinition struct { // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // // Windows containers can mount whole directories on the same drive as $env:ProgramData. - // Windows containers cannot mount directories on a different drive, and mount - // point cannot be across drives. + // Windows containers can't mount directories on a different drive, and mount + // point can't be across drives. MountPoints []*MountPoint `locationName:"mountPoints" type:"list"` - // The name of a container. If you are linking multiple containers together - // in a task definition, the name of one container can be entered in the links + // The name of a container. If you're linking multiple containers together in + // a task definition, the name of one container can be entered in the links // of another container to connect the containers. Up to 255 letters (uppercase // and lowercase), numbers, underscores, and hyphens are allowed. This parameter // maps to name in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) @@ -8025,13 +8076,12 @@ type ContainerDefinition struct { // The list of port mappings for the container. Port mappings allow containers // to access ports on the host container instance to send or receive traffic. // - // For task definitions that use the awsvpc network mode, you should only specify - // the containerPort. The hostPort can be left blank or it must be the same - // value as the containerPort. + // For task definitions that use the awsvpc network mode, only specify the containerPort. + // The hostPort can be left blank or it must be the same value as the containerPort. // // Port mappings on Windows use the NetNAT gateway address rather than localhost. - // There is no loopback for port mappings on Windows, so you cannot access a - // container's mapped port from the host itself. + // There's no loopback for port mappings on Windows, so you can't access a container's + // mapped port from the host itself. // // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) @@ -8087,15 +8137,14 @@ type ContainerDefinition struct { // for a container. For example, you specify two containers in a task definition // with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, // or HEALTHY status. If a startTimeout value is specified for containerB and - // it does not reach the desired status within that time then containerA will - // give up and not start. This results in the task transitioning to a STOPPED - // state. + // it doesn't reach the desired status within that time then containerA gives + // up and not start. This results in the task transitioning to a STOPPED state. // // When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable - // is used, it is enforced indendently from this start timeout value. + // is used, it's enforced independently from this start timeout value. // // For tasks using the Fargate launch type, the task or service requires the - // followiwng platforms: + // following platforms: // // * Linux platform version 1.3.0 or later. // @@ -8106,7 +8155,7 @@ type ContainerDefinition struct { // value. However, we recommend using the latest container agent version. For // information about checking your agent version and updating to the latest // version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) - // in the Amazon Elastic Container Service Developer Guide. If you are using + // in the Amazon Elastic Container Service Developer Guide. If you're using // an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 // of the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container @@ -8119,7 +8168,7 @@ type ContainerDefinition struct { // if it doesn't exit normally on its own. // // For tasks using the Fargate launch type, the task or service requires the - // followiwng platforms: + // following platforms: // // * Linux platform version 1.3.0 or later. // @@ -8128,17 +8177,17 @@ type ContainerDefinition struct { // The max stop timeout value is 120 seconds and if the parameter is not specified, // the default value of 30 seconds is used. // - // For tasks using the EC2 launch type, if the stopTimeout parameter is not + // For tasks that use the EC2 launch type, if the stopTimeout parameter isn't // specified, the value set for the Amazon ECS container agent configuration - // variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout - // parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable - // are set, then the default values of 30 seconds for Linux containers and 30 - // seconds on Windows containers are used. Your container instances require - // at least version 1.26.0 of the container agent to enable a container stop - // timeout value. However, we recommend using the latest container agent version. - // For information about checking your agent version and updating to the latest - // version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) - // in the Amazon Elastic Container Service Developer Guide. If you are using + // variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter + // or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then + // the default values of 30 seconds for Linux containers and 30 seconds on Windows + // containers are used. Your container instances require at least version 1.26.0 + // of the container agent to enable a container stop timeout value. However, + // we recommend using the latest container agent version. For information about + // checking your agent version and updating to the latest version, see Updating + // the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // in the Amazon Elastic Container Service Developer Guide. If you're using // an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 // of the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container @@ -8152,17 +8201,17 @@ type ContainerDefinition struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // It is not recommended that you specify network-related systemControls parameters + // We don't recommended that you specify network-related systemControls parameters // for multiple containers in a single task that also uses either the awsvpc // or host network modes. For tasks that use the awsvpc network mode, the container - // that is started last determines which systemControls parameters take effect. + // that's started last determines which systemControls parameters take effect. // For tasks that use the host network mode, it changes the container instance's // namespaced kernel parameters as well as the containers. SystemControls []*SystemControl `locationName:"systemControls" type:"list"` // A list of ulimits to set in the container. If a ulimit value is specified - // in a task definition, it will override the default values set by Docker. - // This parameter maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // in a task definition, it overrides the default values set by Docker. This + // parameter maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // Valid naming values are displayed in the Ulimit data type. @@ -8186,9 +8235,8 @@ type ContainerDefinition struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --user option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // When running tasks using the host network mode, you should not run containers - // using the root user (UID 0). It is considered best practice to use a non-root - // user. + // When running tasks using the host network mode, don't run containers using + // the root user (UID 0). We recommend using a non-root user for better security. // // You can specify the user using the following formats. If specifying a UID // or GID, you must specify it as a positive integer. @@ -8214,8 +8262,8 @@ type ContainerDefinition struct { // and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"` - // The working directory in which to run commands inside the container. This - // parameter maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // The working directory to run commands inside the container in. This parameter + // maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). WorkingDirectory *string `locationName:"workingDirectory" type:"string"` @@ -8577,7 +8625,7 @@ func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition // the latest container agent version. For information about checking your agent // version and updating to the latest version, see Updating the Amazon ECS Container // Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) -// in the Amazon Elastic Container Service Developer Guide. If you are using +// in the Amazon Elastic Container Service Developer Guide. If you're using // an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 // of the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container @@ -8585,8 +8633,8 @@ func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition // AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. // -// For tasks using the Fargate launch type, the task or service requires the -// followiwng platforms: +// For tasks that use the Fargate launch type, the task or service requires +// the following platforms: // // * Linux platform version 1.3.0 or later. // @@ -8604,11 +8652,11 @@ type ContainerDependency struct { // * COMPLETE - This condition validates that a dependent container runs // to completion (exits) before permitting other containers to start. This // can be useful for nonessential containers that run a script and then exit. - // This condition cannot be set on an essential container. + // This condition can't be set on an essential container. // // * SUCCESS - This condition is the same as COMPLETE, but it also requires - // that the container exits with a zero status. This condition cannot be - // set on an essential container. + // that the container exits with a zero status. This condition can't be set + // on an essential container. // // * HEALTHY - This condition validates that the dependent container passes // its Docker health check before permitting other containers to start. This @@ -8670,7 +8718,7 @@ func (s *ContainerDependency) SetContainerName(v string) *ContainerDependency { return s } -// An EC2 instance that is running the Amazon ECS agent and has been registered +// An EC2 instance that's running the Amazon ECS agent and has been registered // with a cluster. type ContainerInstance struct { _ struct{} `type:"structure"` @@ -8680,7 +8728,7 @@ type ContainerInstance struct { // instances connected to an agent can accept placement requests. AgentConnected *bool `locationName:"agentConnected" type:"boolean"` - // The status of the most recent agent update. If an update has never been requested, + // The status of the most recent agent update. If an update wasn't ever requested, // this value is NULL. AgentUpdateStatus *string `locationName:"agentUpdateStatus" type:"string" enum:"AgentUpdateStatus"` @@ -8691,7 +8739,7 @@ type ContainerInstance struct { // agent at instance registration or manually with the PutAttributes operation. Attributes []*Attribute `locationName:"attributes" type:"list"` - // The capacity provider associated with the container instance. + // The capacity provider that's associated with the container instance. CapacityProviderName *string `locationName:"capacityProviderName" type:"string"` // The Amazon Resource Name (ARN) of the container instance. The ARN contains @@ -8705,10 +8753,13 @@ type ContainerInstance struct { // Web Services Systems Manager managed instance ID. Ec2InstanceId *string `locationName:"ec2InstanceId" type:"string"` + // An object representing the health status of the container instance. + HealthStatus *ContainerInstanceHealthStatus `locationName:"healthStatus" type:"structure"` + // The number of tasks on the container instance that are in the PENDING status. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` - // The Unix timestamp for when the container instance was registered. + // The Unix timestamp for the time when the container instance was registered. RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp"` // For CPU and memory resource types, this parameter describes the amount of @@ -8721,12 +8772,12 @@ type ContainerInstance struct { RegisteredResources []*Resource `locationName:"registeredResources" type:"list"` // For CPU and memory resource types, this parameter describes the remaining - // CPU and memory that has not already been allocated to tasks and is therefore - // available for new tasks. For port resource types, this parameter describes - // the ports that were reserved by the Amazon ECS container agent (at instance - // registration time) and any task containers that have reserved port mappings - // on the host (with the host or bridge network mode). Any port that is not - // specified here is available for new tasks. + // CPU and memory that wasn't already allocated to tasks and is therefore available + // for new tasks. For port resource types, this parameter describes the ports + // that were reserved by the Amazon ECS container agent (at instance registration + // time) and any task containers that have reserved port mappings on the host + // (with the host or bridge network mode). Any port that's not specified here + // is available for new tasks. RemainingResources []*Resource `locationName:"remainingResources" type:"list"` // The number of tasks on the container instance that are in the RUNNING status. @@ -8746,7 +8797,7 @@ type ContainerInstance struct { // status. // // The ACTIVE status indicates that the container instance can accept tasks. - // The DRAINING indicates that new tasks are not placed on the container instance + // The DRAINING indicates that new tasks aren't placed on the container instance // and any service tasks running on the container instance are removed if possible. // For more information, see Container Instance Draining (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) // in the Amazon Elastic Container Service Developer Guide. @@ -8756,8 +8807,8 @@ type ContainerInstance struct { StatusReason *string `locationName:"statusReason" type:"string"` // The metadata that you apply to the container instance to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // and organize them. Each tag consists of a key and an optional value. You + // define both. // // The following basic restrictions apply to tags: // @@ -8785,7 +8836,7 @@ type ContainerInstance struct { // The version counter for the container instance. Every time a container instance // experiences a change that triggers a CloudWatch event, the version counter - // is incremented. If you are replicating your Amazon ECS container instance + // is incremented. If you're replicating your Amazon ECS container instance // state with CloudWatch Events, you can compare the version of a container // instance reported by the Amazon ECS APIs with the version reported in CloudWatch // Events for the container instance (inside the detail object) to verify that @@ -8857,6 +8908,12 @@ func (s *ContainerInstance) SetEc2InstanceId(v string) *ContainerInstance { return s } +// SetHealthStatus sets the HealthStatus field's value. +func (s *ContainerInstance) SetHealthStatus(v *ContainerInstanceHealthStatus) *ContainerInstance { + s.HealthStatus = v + return s +} + // SetPendingTasksCount sets the PendingTasksCount field's value. func (s *ContainerInstance) SetPendingTasksCount(v int64) *ContainerInstance { s.PendingTasksCount = &v @@ -8917,8 +8974,51 @@ func (s *ContainerInstance) SetVersionInfo(v *VersionInfo) *ContainerInstance { return s } -// The overrides that should be sent to a container. An empty container override -// can be passed in. An example of an empty container override would be {"containerOverrides": +// An object representing the health status of the container instance. +type ContainerInstanceHealthStatus struct { + _ struct{} `type:"structure"` + + // An array of objects representing the details of the container instance health + // status. + Details []*InstanceHealthCheckResult `locationName:"details" type:"list"` + + // The overall health status of the container instance. This is an aggregate + // status of all container instance health checks. + OverallStatus *string `locationName:"overallStatus" type:"string" enum:"InstanceHealthCheckState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContainerInstanceHealthStatus) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContainerInstanceHealthStatus) GoString() string { + return s.String() +} + +// SetDetails sets the Details field's value. +func (s *ContainerInstanceHealthStatus) SetDetails(v []*InstanceHealthCheckResult) *ContainerInstanceHealthStatus { + s.Details = v + return s +} + +// SetOverallStatus sets the OverallStatus field's value. +func (s *ContainerInstanceHealthStatus) SetOverallStatus(v string) *ContainerInstanceHealthStatus { + s.OverallStatus = &v + return s +} + +// The overrides that are sent to a container. An empty container override can +// be passed in. An example of an empty container override is {"containerOverrides": // [ ] }. If a non-empty container override is specified, the name parameter // must be included. type ContainerOverride struct { @@ -9060,7 +9160,7 @@ func (s *ContainerOverride) SetResourceRequirements(v []*ResourceRequirement) *C return s } -// An object representing a change in state for a container. +// An object that represents a change in state for a container. type ContainerStateChange struct { _ struct{} `type:"structure"` @@ -9074,7 +9174,7 @@ type ContainerStateChange struct { // The container image SHA 256 digest. ImageDigest *string `locationName:"imageDigest" type:"string"` - // Any network bindings associated with the container. + // Any network bindings that are associated with the container. NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"` // The reason for the state change. @@ -9155,16 +9255,16 @@ type CreateCapacityProviderInput struct { // AutoScalingGroupProvider is a required field AutoScalingGroupProvider *AutoScalingGroupProvider `locationName:"autoScalingGroupProvider" type:"structure" required:"true"` - // The name of the capacity provider. Up to 255 characters are allowed, including - // letters (upper and lowercase), numbers, underscores, and hyphens. The name - // cannot be prefixed with "aws", "ecs", or "fargate". + // The name of the capacity provider. Up to 255 characters are allowed. They + // include letters (both upper and lowercase letters), numbers, underscores + // (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate". // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // The metadata that you apply to the capacity provider to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // The metadata that you apply to the capacity provider to categorize and organize + // them more conveniently. Each tag consists of a key and an optional value. + // You define both of them. // // The following basic restrictions apply to tags: // @@ -9299,9 +9399,9 @@ type CreateClusterInput struct { // actions. // // If specifying a capacity provider that uses an Auto Scaling group, the capacity - // provider must already be created and not already associated with another - // cluster. New Auto Scaling group capacity providers can be created with the - // CreateCapacityProvider API operation. + // provider must be created but not associated with another cluster. New Auto + // Scaling group capacity providers can be created with the CreateCapacityProvider + // API operation. // // To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT // capacity providers. The Fargate capacity providers are available to all accounts @@ -9311,34 +9411,32 @@ type CreateClusterInput struct { // of available capacity providers for a cluster after the cluster is created. CapacityProviders []*string `locationName:"capacityProviders" type:"list"` - // The name of your cluster. If you do not specify a name for your cluster, - // you create a cluster named default. Up to 255 letters (uppercase and lowercase), + // The name of your cluster. If you don't specify a name for your cluster, you + // create a cluster that's named default. Up to 255 letters (uppercase and lowercase), // numbers, underscores, and hyphens are allowed. ClusterName *string `locationName:"clusterName" type:"string"` // The execute command configuration for the cluster. Configuration *ClusterConfiguration `locationName:"configuration" type:"structure"` - // The capacity provider strategy to set as the default for the cluster. When - // a default capacity provider strategy is set for a cluster, when calling the - // RunTask or CreateService APIs with no capacity provider strategy or launch + // The capacity provider strategy to set as the default for the cluster. After + // a default capacity provider strategy is set for a cluster, when you call + // the RunTask or CreateService APIs with no capacity provider strategy or launch // type specified, the default capacity provider strategy for the cluster is // used. // - // If a default capacity provider strategy is not defined for a cluster during - // creation, it can be defined later with the PutClusterCapacityProviders API - // operation. + // If a default capacity provider strategy isn't defined for a cluster when + // it was created, it can be defined later with the PutClusterCapacityProviders + // API operation. DefaultCapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"defaultCapacityProviderStrategy" type:"list"` // The setting to use when creating a cluster. This parameter is used to enable // CloudWatch Container Insights for a cluster. If this value is specified, - // it will override the containerInsights value set with PutAccountSetting or - // PutAccountSettingDefault. + // it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. Settings []*ClusterSetting `locationName:"settings" type:"list"` // The metadata that you apply to the cluster to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. + // them. Each tag consists of a key and an optional value. You define both. // // The following basic restrictions apply to tags: // @@ -9492,12 +9590,12 @@ type CreateServiceInput struct { // A capacity provider strategy may contain a maximum of 6 capacity providers. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` - // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. Up to 32 ASCII characters are allowed. + // An identifier that you provide to ensure the idempotency of the request. + // It must be unique and is case sensitive. Up to 32 ASCII characters are allowed. ClientToken *string `locationName:"clientToken" type:"string"` - // The short name or full Amazon Resource Name (ARN) of the cluster on which - // to run your service. If you do not specify a cluster, the default cluster + // The short name or full Amazon Resource Name (ARN) of the cluster that you + // run your service on. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` @@ -9512,8 +9610,8 @@ type CreateServiceInput struct { // The number of instantiations of the specified task definition to place and // keep running on your cluster. // - // This is required if schedulingStrategy is REPLICA or is not specified. If - // schedulingStrategy is DAEMON then this is not required. + // This is required if schedulingStrategy is REPLICA or isn't specified. If + // schedulingStrategy is DAEMON then this isn't required. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` // Specifies whether to enable Amazon ECS managed tags for the tasks within @@ -9522,26 +9620,26 @@ type CreateServiceInput struct { // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // Whether or not the execute command functionality is enabled for the service. + // Determines whether the execute command functionality is enabled for the service. // If true, this enables execute command functionality on all containers in // the service tasks. EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"` - // The period of time, in seconds, that the Amazon ECS service scheduler should - // ignore unhealthy Elastic Load Balancing target health checks after a task - // has first started. This is only used when your service is configured to use - // a load balancer. If your service has a load balancer defined and you don't - // specify a health check grace period value, the default value of 0 is used. + // The period of time, in seconds, that the Amazon ECS service scheduler ignores + // unhealthy Elastic Load Balancing target health checks after a task has first + // started. This is only used when your service is configured to use a load + // balancer. If your service has a load balancer defined and you don't specify + // a health check grace period value, the default value of 0 is used. // // If your service's tasks take a while to start and respond to Elastic Load // Balancing health checks, you can specify a health check grace period of up - // to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler - // ignores health check status. This grace period can prevent the service scheduler - // from marking tasks as unhealthy and stopping them before they have time to - // come up. + // to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS + // service scheduler ignores health check status. This grace period can prevent + // the service scheduler from marking tasks as unhealthy and stopping them before + // they have time to come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` - // The infrastructure on which to run your service. For more information, see + // The infrastructure that you run your service on. For more information, see // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. // @@ -9555,7 +9653,7 @@ type CreateServiceInput struct { // The EC2 launch type runs your tasks on Amazon EC2 instances registered to // your cluster. // - // The EXTERNAL launch type runs your tasks on your on-premise server or virtual + // The EXTERNAL launch type runs your tasks on your on-premises server or virtual // machine (VM) capacity registered to your cluster. // // A service can use either a launch type or a capacity provider strategy. If @@ -9567,76 +9665,78 @@ type CreateServiceInput struct { // For more information, see Service Load Balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) // in the Amazon Elastic Container Service Developer Guide. // - // If the service is using the rolling update (ECS) deployment controller and - // using either an Application Load Balancer or Network Load Balancer, you must - // specify one or more target group ARNs to attach to the service. The service-linked - // role is required for services that make use of multiple target groups. For - // more information, see Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) + // If the service uses the rolling update (ECS) deployment controller and using + // either an Application Load Balancer or Network Load Balancer, you must specify + // one or more target group ARNs to attach to the service. The service-linked + // role is required for services that use multiple target groups. For more information, + // see Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. // - // If the service is using the CODE_DEPLOY deployment controller, the service - // is required to use either an Application Load Balancer or Network Load Balancer. + // If the service uses the CODE_DEPLOY deployment controller, the service is + // required to use either an Application Load Balancer or Network Load Balancer. // When creating an CodeDeploy deployment group, you specify two target groups // (referred to as a targetGroupPair). During a deployment, CodeDeploy determines - // which task set in your service has the status PRIMARY and associates one - // target group with it, and then associates the other target group with the - // replacement task set. The load balancer can also have up to two listeners: - // a required listener for production traffic and an optional listener that - // allows you perform validation tests with Lambda functions before routing - // production traffic to it. + // which task set in your service has the status PRIMARY, and it associates + // one target group with it. Then, it also associates the other target group + // with the replacement task set. The load balancer can also have up to two + // listeners: a required listener for production traffic and an optional listener + // that you can use to perform validation tests with Lambda functions before + // routing production traffic to it. // // After you create a service using the ECS deployment controller, the load - // balancer name or target group ARN, container name, and container port specified - // in the service definition are immutable. If you are using the CODE_DEPLOY + // balancer name or target group ARN, container name, and container port that's + // specified in the service definition are immutable. If you use the CODE_DEPLOY // deployment controller, these values can be changed when updating the service. // // For Application Load Balancers and Network Load Balancers, this object must - // contain the load balancer target group ARN, the container name (as it appears - // in a container definition), and the container port to access from the load - // balancer. The load balancer name parameter must be omitted. When a task from - // this service is placed on a container instance, the container instance and - // port combination is registered as a target in the target group specified - // here. + // contain the load balancer target group ARN, the container name, and the container + // port to access from the load balancer. The container name must be as it appears + // in a container definition. The load balancer name parameter must be omitted. + // When a task from this service is placed on a container instance, the container + // instance and port combination is registered as a target in the target group + // that's specified here. // // For Classic Load Balancers, this object must contain the load balancer name, - // the container name (as it appears in a container definition), and the container - // port to access from the load balancer. The target group ARN parameter must - // be omitted. When a task from this service is placed on a container instance, - // the container instance is registered with the load balancer specified here. + // the container name , and the container port to access from the load balancer. + // The container name must be as it appears in a container definition. The target + // group ARN parameter must be omitted. When a task from this service is placed + // on a container instance, the container instance is registered with the load + // balancer that's specified here. // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and - // Network Load Balancers. Classic Load Balancers are not supported. Also, when + // Network Load Balancers. Classic Load Balancers aren't supported. Also, when // you create any target groups for these services, you must choose ip as the - // target type, not instance, because tasks that use the awsvpc network mode - // are associated with an elastic network interface, not an Amazon EC2 instance. + // target type, not instance. This is because tasks that use the awsvpc network + // mode are associated with an elastic network interface, not an Amazon EC2 + // instance. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The network configuration for the service. This parameter is required for // task definitions that use the awsvpc network mode to receive their own elastic - // network interface, and it is not supported for other network modes. For more + // network interface, and it isn't supported for other network modes. For more // information, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // An array of placement constraint objects to use for tasks in your service. - // You can specify a maximum of 10 constraints per task (this limit includes - // constraints in the task definition and those specified at runtime). + // You can specify a maximum of 10 constraints for each task. This limit includes + // constraints in the task definition and those specified at runtime. PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for tasks in your service. You can - // specify a maximum of 5 strategy rules per service. + // specify a maximum of 5 strategy rules for each service. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` // The platform version that your tasks in the service are running on. A platform // version is specified only for tasks using the Fargate launch type. If one - // isn't specified, the LATEST platform version is used by default. For more - // information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // isn't specified, the LATEST platform version is used. 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"` // Specifies whether to propagate the tags from the task definition or the service - // to the tasks in the service. If no value is specified, the tags are not propagated. + // to the tasks in the service. If no value is specified, the tags aren't propagated. // Tags can only be propagated to the tasks within the service during service // creation. To add tags to a task after service creation or task creation, // use the TagResource API action. @@ -9645,17 +9745,17 @@ type CreateServiceInput struct { // The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon // ECS to make calls to your load balancer on your behalf. This parameter is // only permitted if you are using a load balancer with your service and your - // task definition does not use the awsvpc network mode. If you specify the - // role parameter, you must also specify a load balancer object with the loadBalancers + // task definition doesn't use the awsvpc network mode. If you specify the role + // parameter, you must also specify a load balancer object with the loadBalancers // parameter. // // If your account has already created the Amazon ECS service-linked role, that - // role is used by default for your service unless you specify a role here. - // The service-linked role is required if your task definition uses the awsvpc - // network mode or if the service is configured to use service discovery, an - // external deployment controller, multiple target groups, or Elastic Inference - // accelerators in which case you should not specify a role here. For more information, - // see Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) + // role is used for your service unless you specify a role here. The service-linked + // role is required if your task definition uses the awsvpc network mode or + // if the service is configured to use service discovery, an external deployment + // controller, multiple target groups, or Elastic Inference accelerators in + // which case you don't specify a role here. For more information, see Using + // service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. // // If your specified role has a path other than /, then you must either specify @@ -9675,14 +9775,14 @@ type CreateServiceInput struct { // number of tasks across your cluster. By default, the service scheduler // spreads tasks across Availability Zones. You can use task placement strategies // and constraints to customize task placement decisions. This scheduler - // strategy is required if the service is using the CODE_DEPLOY or EXTERNAL - // deployment controller types. + // strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment + // controller types. // // * DAEMON-The daemon scheduling strategy deploys exactly one task on each // active container instance that meets all of the task placement constraints // that you specify in your cluster. The service scheduler also evaluates // the task placement constraints for running tasks and will stop tasks that - // do not meet the placement constraints. When you're using this strategy, + // don't meet the placement constraints. When you're using this strategy, // you don't need to specify a desired number of tasks, a task placement // strategy, or use Service Auto Scaling policies. Tasks using the Fargate // launch type or the CODE_DEPLOY or EXTERNAL deployment controller types @@ -9701,7 +9801,7 @@ type CreateServiceInput struct { // For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). // // Each service may be associated with one service registry. Multiple service - // registries per service isn't supported. + // registries for each service isn't supported. ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"` // The metadata that you apply to the service to help you categorize and organize @@ -9733,11 +9833,11 @@ type CreateServiceInput struct { Tags []*Tag `locationName:"tags" type:"list"` // The family and revision (family:revision) or full ARN of the task definition - // to run in your service. If a revision is not specified, the latest ACTIVE + // to run in your service. If a revision isn't specified, the latest ACTIVE // revision is used. // - // A task definition must be specified if the service is using either the ECS - // or CODE_DEPLOY deployment controllers. + // A task definition must be specified if the service uses either the ECS or + // CODE_DEPLOY deployment controllers. TaskDefinition *string `locationName:"taskDefinition" type:"string"` } @@ -9945,12 +10045,12 @@ type CreateServiceOutput struct { // The full description of your service following the create call. // // A service will return either a capacityProviderStrategy or launchType parameter, - // but not both, depending on which one was specified during creation. + // but not both, depending where one was specified when it was created. // // If a service is using the ECS deployment controller, the deploymentController // and taskSets parameters will not be returned. // - // If the service is using the CODE_DEPLOY deployment controller, the deploymentController, + // if the service uses the CODE_DEPLOY deployment controller, the deploymentController, // taskSets and deployments parameters will be returned, however the deployments // parameter will be an empty list. Service *Service `locationName:"service" type:"structure"` @@ -10007,8 +10107,9 @@ type CreateTaskSetInput struct { // of available capacity providers for a cluster after the cluster is created. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` - // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. Up to 32 ASCII characters are allowed. + // The identifier that you provide to ensure the idempotency of the request. + // It's case sensitive and must be unique. It can be up to 32 ASCII characters + // are allowed. ClientToken *string `locationName:"clientToken" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster that hosts @@ -10023,7 +10124,7 @@ type CreateTaskSetInput struct { // set to the provided value. ExternalId *string `locationName:"externalId" type:"string"` - // The launch type that new tasks in the task set will use. For more information, + // The launch type that new tasks in the task set uses. For more information, // see Amazon ECS Launch Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. // @@ -10039,9 +10140,9 @@ type CreateTaskSetInput struct { // An object representing the network configuration for a task set. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` - // The platform version that the tasks in the task set should use. A platform - // version is specified only for tasks using the Fargate launch type. If one - // isn't specified, the LATEST platform version is used by default. + // The platform version that the tasks in the task set uses. A platform version + // is specified only for tasks using the Fargate launch type. If one isn't specified, + // the LATEST platform version is used. PlatformVersion *string `locationName:"platformVersion" type:"string"` // A floating-point percentage of the desired number of tasks to place and keep @@ -10059,8 +10160,8 @@ type CreateTaskSetInput struct { ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"` // The metadata that you apply to the task set to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. When a service is deleted, the tags are deleted as well. + // them. Each tag consists of a key and an optional value. You define both. + // When a service is deleted, the tags are deleted. // // The following basic restrictions apply to tags: // @@ -10269,7 +10370,7 @@ func (s *CreateTaskSetOutput) SetTaskSet(v *TaskSet) *CreateTaskSetOutput { type DeleteAccountSettingInput struct { _ struct{} `type:"structure"` - // The resource name for which to disable the account setting. If serviceLongArnFormat + // The resource name to disable the account setting for. If serviceLongArnFormat // is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat // is specified, the ARN and resource ID for your Amazon ECS tasks is affected. // If containerInstanceLongArnFormat is specified, the ARN and resource ID for @@ -10279,11 +10380,11 @@ type DeleteAccountSettingInput struct { // Name is a required field Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"` - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If you specify the root user, it disables the account setting for all - // IAM users, IAM roles, and the root user of the account unless an IAM user - // or role explicitly overrides these settings. If this field is omitted, the - // setting is changed only for the authenticated user. + // The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM + // role, or the root user. If you specify the root user, it disables the account + // setting for all IAM users, IAM roles, and the root user of the account unless + // an IAM user or role explicitly overrides these settings. If this field is + // omitted, the setting is changed only for the authenticated user. PrincipalArn *string `locationName:"principalArn" type:"string"` } @@ -10365,9 +10466,9 @@ type DeleteAttributesInput struct { _ struct{} `type:"structure"` // The attributes to delete from your resource. You can specify up to 10 attributes - // per request. For custom attributes, specify the attribute name and target - // ID, but do not specify the value. If you specify the target ID using the - // short form, you must also specify the target type. + // for each request. For custom attributes, specify the attribute name and target + // ID, but don't specify the value. If you specify the target ID using the short + // form, you must also specify the target type. // // Attributes is a required field Attributes []*Attribute `locationName:"attributes" type:"list" required:"true"` @@ -10625,9 +10726,9 @@ type DeleteServiceInput struct { // is assumed. Cluster *string `locationName:"cluster" type:"string"` - // If true, allows you to delete a service even if it has not been scaled down - // to zero tasks. It is only necessary to use this if the service is using the - // REPLICA scheduling strategy. + // If true, allows you to delete a service even if it wasn't scaled down to + // zero tasks. It's only necessary to use this if the service uses the REPLICA + // scheduling strategy. Force *bool `locationName:"force" type:"boolean"` // The name of the service to delete. @@ -10720,13 +10821,13 @@ type DeleteTaskSetInput struct { _ struct{} `type:"structure"` // The short name or full Amazon Resource Name (ARN) of the cluster that hosts - // the service that the task set exists in to delete. + // the service that the task set found in to delete. // // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` - // If true, this allows you to delete a task set even if it hasn't been scaled - // down to zero. + // If true, you can delete a task set even if it hasn't been scaled down to + // zero. Force *bool `locationName:"force" type:"boolean"` // The short name or full Amazon Resource Name (ARN) of the service that hosts @@ -10841,7 +10942,7 @@ type Deployment struct { // The capacity provider strategy that the deployment is using. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` - // The Unix timestamp for when the service deployment was created. + // The Unix timestamp for the time when the service deployment was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The most recent desired count of tasks that was specified for the service @@ -10880,23 +10981,23 @@ type Deployment struct { // value as the service, for example, LINUX.. PlatformFamily *string `locationName:"platformFamily" type:"string"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If one - // is not specified, the LATEST platform version is used by default. For more - // information, see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version that your tasks in the service run on. A platform version + // is only specified for tasks using the Fargate launch type. If one isn't specified, + // the LATEST platform version is used. 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"` // // The rolloutState of a service is only returned for services that use the - // rolling update (ECS) deployment type that are not behind a Classic Load Balancer. + // rolling update (ECS) deployment type that aren't behind a Classic Load Balancer. // // The rollout state of the deployment. When a service deployment is started, // it begins in an IN_PROGRESS state. When the service reaches a steady state, - // the deployment will transition to a COMPLETED state. If the service fails - // to reach a steady state and circuit breaker is enabled, the deployment will - // transition to a FAILED state. A deployment in FAILED state will launch no - // new tasks. For more information, see DeploymentCircuitBreaker. + // the deployment transitions to a COMPLETED state. If the service fails to + // reach a steady state and circuit breaker is enabled, the deployment transitions + // to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. + // For more information, see DeploymentCircuitBreaker. RolloutState *string `locationName:"rolloutState" type:"string" enum:"DeploymentRolloutState"` // A description of the rollout state of a deployment. @@ -10905,7 +11006,7 @@ type Deployment struct { // The number of tasks in the deployment that are in the RUNNING status. RunningCount *int64 `locationName:"runningCount" type:"integer"` - // The status of the deployment. The following describes each state: + // The status of the deployment. The following describes each state. // // PRIMARY // @@ -10925,7 +11026,7 @@ type Deployment struct { // to use. TaskDefinition *string `locationName:"taskDefinition" type:"string"` - // The Unix timestamp for when the service deployment was last updated. + // The Unix timestamp for the time when the service deployment was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -11045,7 +11146,7 @@ func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment { // // The deployment circuit breaker can only be used for services using the rolling -// update (ECS) deployment type that are not behind a Classic Load Balancer. +// update (ECS) deployment type that aren't behind a Classic Load Balancer. // // The deployment circuit breaker determines whether a service deployment will // fail if the service can't reach a steady state. If enabled, a service deployment @@ -11056,14 +11157,15 @@ func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment { type DeploymentCircuitBreaker struct { _ struct{} `type:"structure"` - // Whether to enable the deployment circuit breaker logic for the service. + // Determines whether to enable the deployment circuit breaker logic for the + // service. // // Enable is a required field Enable *bool `locationName:"enable" type:"boolean" required:"true"` - // Whether to enable Amazon ECS to roll back the service if a service deployment - // fails. If rollback is enabled, when a service deployment fails, the service - // is rolled back to the last deployment that completed successfully. + // Determines whether to enable Amazon ECS to roll back the service if a service + // deployment fails. If rollback is enabled, when a service deployment fails, + // the service is rolled back to the last deployment that completed successfully. // // Rollback is a required field Rollback *bool `locationName:"rollback" type:"boolean" required:"true"` @@ -11162,10 +11264,10 @@ type DeploymentConfiguration struct { // number of four tasks and a minimum healthy percent of 50%, the scheduler // may stop two existing tasks to free up cluster capacity before starting two // new tasks. Tasks for services that do not use a load balancer are considered - // healthy if they are in the RUNNING state; tasks for services that do use - // a load balancer are considered healthy if they are in the RUNNING state and - // they are reported as healthy by the load balancer. The default value for - // minimum healthy percent is 100%. + // healthy if they're in the RUNNING state; tasks for services that do use a + // load balancer are considered healthy if they're in the RUNNING state and + // they're reported as healthy by the load balancer. The default value for minimum + // healthy percent is 100%. // // If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment // types and tasks that use the EC2 launch type, the minimum healthy percent @@ -11316,10 +11418,10 @@ type DeregisterContainerInstanceInput struct { // ContainerInstance is a required field ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` - // Forces the deregistration of the container instance. If you have tasks running + // Forces the container instance to be deregistered. If you have tasks running // on the container instance when you deregister it with the force option, these // tasks remain running until you terminate the instance or the tasks stop through - // some other means, but they are orphaned (no longer monitored or accounted + // some other means, but they're orphaned (no longer monitored or accounted // for by Amazon ECS). If an orphaned task on your container instance is part // of an Amazon ECS service, then the service scheduler starts another copy // of that task, on a different container instance if possible. @@ -11498,7 +11600,7 @@ type DescribeCapacityProvidersInput struct { // Specifies whether or not you want to see the resource tags for the capacity // provider. If TAGS is specified, the tags are included in the response. If - // this field is omitted, tags are not included in the response. + // this field is omitted, tags aren't included in the response. Include []*string `locationName:"include" type:"list"` // The maximum number of account setting results returned by DescribeCapacityProviders @@ -11621,8 +11723,8 @@ type DescribeClustersInput struct { // entries. If you do not specify a cluster, the default cluster is assumed. Clusters []*string `locationName:"clusters" type:"list"` - // Whether to include additional information about the clusters in the response. - // If this field is omitted, this information isn't included. + // Determines whether to include additional information about the clusters in + // the response. If this field is omitted, this information isn't included. // // If ATTACHMENTS is specified, the attachments for the container instances // or tasks within the cluster are included. @@ -11725,8 +11827,10 @@ type DescribeContainerInstancesInput struct { ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` // Specifies whether you want to see the resource tags for the container instance. - // If TAGS is specified, the tags are included in the response. If this field - // is omitted, tags are not included in the response. + // If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH + // is specified, the container instance health is included in the response. + // If this field is omitted, tags and container instance health status aren't + // included in the response. Include []*string `locationName:"include" type:"list"` } @@ -11828,9 +11932,9 @@ type DescribeServicesInput struct { // describing were launched in any cluster other than the default cluster. Cluster *string `locationName:"cluster" type:"string"` - // Specifies whether you want to see the resource tags for the service. If TAGS - // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. + // Determines whether you want to see the resource tags for the service. If + // TAGS is specified, the tags are included in the response. If this field is + // omitted, tags aren't included in the response. Include []*string `locationName:"include" type:"list"` // A list of services to describe. You may specify up to 10 services to describe @@ -11932,9 +12036,9 @@ func (s *DescribeServicesOutput) SetServices(v []*Service) *DescribeServicesOutp type DescribeTaskDefinitionInput struct { _ struct{} `type:"structure"` - // Specifies whether to see the resource tags for the task definition. If TAGS + // Determines whether to see the resource tags for the task definition. If TAGS // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. + // tags aren't included in the response. Include []*string `locationName:"include" type:"list"` // The family for the latest ACTIVE revision, family and revision (family:revision) @@ -11991,9 +12095,9 @@ func (s *DescribeTaskDefinitionInput) SetTaskDefinition(v string) *DescribeTaskD type DescribeTaskDefinitionOutput struct { _ struct{} `type:"structure"` - // The metadata that is applied to the task definition to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // The metadata that's applied to the task definition to help you categorize + // and organize them. Each tag consists of a key and an optional value. You + // define both. // // The following basic restrictions apply to tags: // @@ -12063,8 +12167,8 @@ type DescribeTaskSetsInput struct { Cluster *string `locationName:"cluster" type:"string" required:"true"` // Specifies whether to see the resource tags for the task set. If TAGS is specified, - // the tags are included in the response. If this field is omitted, tags are - // not included in the response. + // the tags are included in the response. If this field is omitted, tags aren't + // included in the response. Include []*string `locationName:"include" type:"list"` // The short name or full Amazon Resource Name (ARN) of the service that the @@ -12186,7 +12290,7 @@ type DescribeTasksInput struct { // Specifies whether you want to see the resource tags for the task. If TAGS // is specified, the tags are included in the response. If this field is omitted, - // tags are not included in the response. + // tags aren't included in the response. Include []*string `locationName:"include" type:"list"` // A list of up to 100 task IDs or full ARN entries. @@ -12353,8 +12457,8 @@ func (s *Device) SetPermissions(v []*string) *Device { type DiscoverPollEndpointInput struct { _ struct{} `type:"structure"` - // The short name or full Amazon Resource Name (ARN) of the cluster to which - // the container instance belongs. + // The short name or full Amazon Resource Name (ARN) of the cluster that the + // container instance belongs to. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full ARN of the container instance. The ARN @@ -12435,14 +12539,14 @@ func (s *DiscoverPollEndpointOutput) SetTelemetryEndpoint(v string) *DiscoverPol return s } -// This parameter is specified when you are using Docker volumes. Docker volumes -// are only supported when you are using the EC2 launch type. Windows containers +// This parameter is specified when you're using Docker volumes. Docker volumes +// are only supported when you're using the EC2 launch type. Windows containers // only support the use of the local driver. To use bind mounts, specify a host // instead. type DockerVolumeConfiguration struct { _ struct{} `type:"structure"` - // If this value is true, the Docker volume is created if it does not already + // If this value is true, the Docker volume is created if it doesn't already // exist. // // This field is only used if the scope is shared. @@ -12539,11 +12643,11 @@ type EFSAuthorizationConfig struct { // in the Amazon Elastic File System User Guide. AccessPointId *string `locationName:"accessPointId" type:"string"` - // Whether or not to use the Amazon ECS task IAM role defined in a task 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/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) + // Determines whether to use the Amazon ECS task IAM role defined in a task + // 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/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) // in the Amazon Elastic Container Service Developer Guide. Iam *string `locationName:"iam" type:"string" enum:"EFSAuthorizationConfigIAM"` } @@ -12578,7 +12682,7 @@ func (s *EFSAuthorizationConfig) SetIam(v string) *EFSAuthorizationConfig { return s } -// This parameter is specified when you are using an Amazon Elastic File System +// This parameter is specified when you're using an Amazon Elastic File System // file system for task storage. For more information, see Amazon EFS Volumes // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) // in the Amazon Elastic Container Service Developer Guide. @@ -12603,7 +12707,7 @@ type EFSVolumeConfiguration struct { // the path set on the 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 @@ -12684,15 +12788,15 @@ func (s *EFSVolumeConfiguration) SetTransitEncryptionPort(v int64) *EFSVolumeCon // You can specify up to ten environment files. The file must have a .env file // extension. Each line in an environment file should contain an environment // variable in VARIABLE=VALUE format. Lines beginning with # are treated as -// comments and are ignored. For more information on the environment variable +// comments and are ignored. For more information about the environment variable // file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/). // // If there are environment variables specified using the environment parameter // in a container definition, they take precedence over the variables contained // within an environment file. If multiple environment files are specified that -// contain the same variable, they are processed from the top down. It is recommended -// to use unique variable names. For more information, see Specifying environment -// variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) +// contain the same variable, they're processed from the top down. We recommend +// that you use unique variable names. For more information, see Specifying +// environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. // // This parameter is only supported for tasks hosted on Fargate using the following @@ -12983,7 +13087,7 @@ func (s *ExecuteCommandInput) SetTask(v string) *ExecuteCommandInput { type ExecuteCommandLogConfiguration struct { _ struct{} `type:"structure"` - // Whether or not to enable encryption on the CloudWatch logs. If not specified, + // Determines whether to enable encryption on the CloudWatch logs. If not specified, // encryption will be disabled. CloudWatchEncryptionEnabled *bool `locationName:"cloudWatchEncryptionEnabled" type:"boolean"` @@ -12997,7 +13101,7 @@ type ExecuteCommandLogConfiguration struct { // The S3 bucket must already be created. S3BucketName *string `locationName:"s3BucketName" type:"string"` - // Whether or not to use encryption on the S3 logs. If not specified, encryption + // Determines whether to use encryption on the S3 logs. If not specified, encryption // is not used. S3EncryptionEnabled *bool `locationName:"s3EncryptionEnabled" type:"boolean"` @@ -13065,9 +13169,9 @@ type ExecuteCommandOutput struct { // The name of the container. ContainerName *string `locationName:"containerName" type:"string"` - // Whether or not the execute command session is running in interactive mode. - // Amazon ECS only supports initiating interactive sessions, so you must specify - // true for this value. + // Determines whether the execute command session is running in interactive + // mode. Amazon ECS only supports initiating interactive sessions, so you must + // specify true for this value. Interactive *bool `locationName:"interactive" type:"boolean"` // The details of the SSM session that was created for this instance of execute-command. @@ -13202,7 +13306,7 @@ func (s *FSxWindowsFileServerAuthorizationConfig) SetDomain(v string) *FSxWindow return s } -// This parameter is specified when you are using Amazon FSx for Windows File +// This parameter is specified when you're using Amazon FSx for Windows File // Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) // file system for task storage. // @@ -13422,7 +13526,7 @@ func (s *FirelensConfiguration) SetType(v string) *FirelensConfiguration { // // * UNHEALTHY-The container health check has failed. // -// * UNKNOWN-The container health check is being evaluated or there is no +// * UNKNOWN-The container health check is being evaluated or there's no // container health check defined. // // The following describes the possible healthStatus values for a task. The @@ -13449,12 +13553,12 @@ func (s *FirelensConfiguration) SetType(v string) *FirelensConfiguration { // ECS container agent. For more information, see Updating the Amazon ECS // Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). // -// * Container health checks are supported for Fargate tasks if you are using +// * Container health checks are supported for Fargate tasks if you're using // platform version 1.1.0 or greater. For more information, see Fargate Platform // Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). // -// * Container health checks are not supported for tasks that are part of -// a service that is configured to use a Classic Load Balancer. +// * Container health checks aren't supported for tasks that are part of +// a service that's configured to use a Classic Load Balancer. type HealthCheck struct { _ struct{} `type:"structure"` @@ -13464,13 +13568,12 @@ type HealthCheck struct { // default shell. // // When you use the Amazon Web Services Management Console JSON panel, the Command - // Line Interface, or the APIs, you should enclose the list of commands in brackets, - // as shown below. + // Line Interface, or the APIs, enclose the list of commands in brackets. // // [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] // - // You do not need to include the brackets when you use the Amazon Web Services - // Management Consoleas shown below. + // You don't need to include the brackets when you use the Amazon Web Services + // Management Console. // // "CMD-SHELL", "curl -f http://localhost/ || exit 1" // @@ -13490,10 +13593,9 @@ type HealthCheck struct { // value is 3. Retries *int64 `locationName:"retries" type:"integer"` - // The optional grace period within which to provide containers time to bootstrap - // before failed health checks count towards the maximum number of retries. - // You may specify between 0 and 300 seconds. The startPeriod is disabled by - // default. + // The optional grace period to provide containers time to bootstrap before + // failed health checks count towards the maximum number of retries. You can + // specify between 0 and 300 seconds. By default, the startPeriod is disabled. // // If a health check succeeds within the startPeriod, then the container is // considered healthy and any subsequent failures count toward the maximum number @@ -13634,15 +13736,15 @@ type HostVolumeProperties struct { _ struct{} `type:"structure"` // When the host parameter is used, specify a sourcePath to declare the path - // on the host container instance that is presented to the container. If this + // 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 the host parameter contains a sourcePath file location, then the data // volume persists at the specified location on the host container instance - // until you delete it manually. If the sourcePath value does not exist on the + // until you delete it manually. If the sourcePath value 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. // - // If you are using the Fargate launch type, the sourcePath parameter is not + // If you're using the Fargate launch type, the sourcePath parameter is not // supported. SourcePath *string `locationName:"sourcePath" type:"string"` } @@ -13671,7 +13773,7 @@ func (s *HostVolumeProperties) SetSourcePath(v string) *HostVolumeProperties { return s } -// Details on a Elastic Inference accelerator. For more information, see Working +// Details on an Elastic Inference accelerator. For more information, see Working // with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) // in the Amazon Elastic Container Service Developer Guide. type InferenceAccelerator struct { @@ -13781,8 +13883,68 @@ func (s *InferenceAcceleratorOverride) SetDeviceType(v string) *InferenceAcceler return s } -// The specified parameter is invalid. Review the available parameters for the -// API request. +// An object representing the result of a container instance health status check. +type InstanceHealthCheckResult struct { + _ struct{} `type:"structure"` + + // The Unix timestamp for when the container instance health status last changed. + LastStatusChange *time.Time `locationName:"lastStatusChange" type:"timestamp"` + + // The Unix timestamp for when the container instance health status was last + // updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The container instance health status. + Status *string `locationName:"status" type:"string" enum:"InstanceHealthCheckState"` + + // The type of container instance health status that was verified. + Type *string `locationName:"type" type:"string" enum:"InstanceHealthCheckType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InstanceHealthCheckResult) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InstanceHealthCheckResult) GoString() string { + return s.String() +} + +// SetLastStatusChange sets the LastStatusChange field's value. +func (s *InstanceHealthCheckResult) SetLastStatusChange(v time.Time) *InstanceHealthCheckResult { + s.LastStatusChange = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *InstanceHealthCheckResult) SetLastUpdated(v time.Time) *InstanceHealthCheckResult { + s.LastUpdated = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *InstanceHealthCheckResult) SetStatus(v string) *InstanceHealthCheckResult { + s.Status = &v + return s +} + +// SetType sets the Type field's value. +func (s *InstanceHealthCheckResult) SetType(v string) *InstanceHealthCheckResult { + s.Type = &v + return s +} + +// The specified parameter isn't valid. Review the available parameters for +// the API request. type InvalidParameterException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -13847,10 +14009,10 @@ func (s *InvalidParameterException) RequestID() string { } // The Linux capabilities for the container that are added to or dropped from -// the default configuration provided by Docker. For more information on the -// default capabilities and the non-default available capabilities, see Runtime -// privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) -// in the Docker run reference. For more detailed information on these Linux +// the default configuration provided by Docker. For more information about +// the default capabilities and the non-default available capabilities, see +// Runtime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) +// in the Docker run reference. For more detailed information about these Linux // capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) // Linux manual page. type KernelCapabilities struct { @@ -13964,7 +14126,7 @@ func (s *KeyValuePair) SetValue(v string) *KeyValuePair { return s } -// The limit for the resource has been exceeded. +// The limit for the resource was exceeded. type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -14045,8 +14207,8 @@ type LinuxParameters struct { // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --device option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // If you are using tasks that use the Fargate launch type, the devices parameter - // is not supported. + // If you're using tasks that use the Fargate launch type, the devices parameter + // isn't supported. Devices []*Device `locationName:"devices" type:"list"` // Run an init process inside the container that forwards signals and reaps @@ -14068,8 +14230,8 @@ type LinuxParameters struct { // it is running on. A maxSwap value must be set for the swappiness parameter // to be used. // - // If you are using tasks that use the Fargate launch type, the maxSwap parameter - // is not supported. + // If you're using tasks that use the Fargate launch type, the maxSwap parameter + // isn't supported. MaxSwap *int64 `locationName:"maxSwap" type:"integer"` // The value for the size (in MiB) of the /dev/shm volume. This parameter maps @@ -14087,15 +14249,15 @@ type LinuxParameters struct { // for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness // option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // - // If you are using tasks that use the Fargate launch type, the swappiness parameter - // is not supported. + // If you're using tasks that use the Fargate launch type, the swappiness parameter + // isn't supported. 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/#security-configuration). // - // If you are using tasks that use the Fargate launch type, the tmpfs parameter - // is not supported. + // If you're using tasks that use the Fargate launch type, the tmpfs parameter + // isn't supported. Tmpfs []*Tmpfs `locationName:"tmpfs" type:"list"` } @@ -14192,10 +14354,10 @@ func (s *LinuxParameters) SetTmpfs(v []*Tmpfs) *LinuxParameters { type ListAccountSettingsInput struct { _ struct{} `type:"structure"` - // Specifies whether to return the effective settings. If true, the account + // Determines whether to return the effective settings. If true, the account // settings for the root user or the default setting for the principalArn are // returned. If false, the account settings for the principalArn are returned - // if they are set. Otherwise, no account settings are returned. + // if they're set. Otherwise, no account settings are returned. EffectiveSettings *bool `locationName:"effectiveSettings" type:"boolean"` // The maximum number of account setting results returned by ListAccountSettings @@ -14203,7 +14365,7 @@ type ListAccountSettingsInput struct { // 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 ListAccountSettings request with the returned nextToken value. This - // value can be between 1 and 10. If this parameter is not used, then ListAccountSettings + // value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings // returns up to 10 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -14212,8 +14374,8 @@ type ListAccountSettingsInput struct { // The nextToken value returned from a ListAccountSettings request indicating // that more results are available to fulfill the request and further calls - // will be needed. If maxResults was provided, it is possible the number of - // results to be fewer than maxResults. + // will be needed. If maxResults was provided, it's possible the number of results + // to be fewer than maxResults. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. @@ -14227,8 +14389,8 @@ type ListAccountSettingsInput struct { // explicit account settings set for them. PrincipalArn *string `locationName:"principalArn" type:"string"` - // The value of the account settings with which to filter results. You must - // also specify an account setting name to use this parameter. + // The value of the account settings to filter results with. You must also specify + // an account setting name to use this parameter. Value *string `locationName:"value" type:"string"` } @@ -14332,10 +14494,10 @@ func (s *ListAccountSettingsOutput) SetSettings(v []*Setting) *ListAccountSettin type ListAttributesInput struct { _ struct{} `type:"structure"` - // The name of the attribute with which to filter the results. + // The name of the attribute to filter the results with. AttributeName *string `locationName:"attributeName" type:"string"` - // The value of the attribute with which to filter results. You must also specify + // The value of the attribute to filter results with. You must also specify // an attribute name to use this parameter. AttributeValue *string `locationName:"attributeValue" type:"string"` @@ -14343,25 +14505,25 @@ type ListAttributesInput struct { // attributes. If you do not specify a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` - // The maximum number of cluster results returned by ListAttributes in paginated + // The maximum number of cluster results that ListAttributes returned in paginated // output. When this parameter is used, ListAttributes 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 ListAttributes // request with the returned nextToken value. This value can be between 1 and - // 100. If this parameter is not used, then ListAttributes returns up to 100 + // 100. If this parameter isn't used, then ListAttributes returns up to 100 // results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListAttributes request indicating that - // more results are available to fulfill the request and further calls will - // be needed. If maxResults was provided, it is possible the number of results - // to be fewer than maxResults. + // more results are available to fulfill the request and further calls are needed. + // If maxResults was provided, it's possible the number of results to be fewer + // than maxResults. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` - // The type of the target with which to list attributes. + // The type of the target to list attributes with. // // TargetType is a required field TargetType *string `locationName:"targetType" type:"string" required:"true" enum:"TargetType"` @@ -14480,19 +14642,19 @@ func (s *ListAttributesOutput) SetNextToken(v string) *ListAttributesOutput { type ListClustersInput struct { _ struct{} `type:"structure"` - // The maximum number of cluster results returned by ListClusters in paginated + // The maximum number of cluster results that ListClusters returned in paginated // output. When this parameter is used, ListClusters 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 ListClusters // request with the returned nextToken value. This value can be between 1 and - // 100. If this parameter is not used, then ListClusters returns up to 100 results + // 100. If this parameter isn't used, then ListClusters returns up to 100 results // and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListClusters request indicating that - // more results are available to fulfill the request and further calls will - // be needed. If maxResults was provided, it is possible the number of results - // to be fewer than maxResults. + // more results are available to fulfill the request and further calls are needed. + // If maxResults was provided, it's possible the number of results to be fewer + // than maxResults. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. @@ -14532,8 +14694,8 @@ func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput { type ListClustersOutput struct { _ struct{} `type:"structure"` - // The list of full Amazon Resource Name (ARN) entries for each cluster associated - // with your account. + // The list of full Amazon Resource Name (ARN) entries for each cluster that's + // associated with your account. ClusterArns []*string `locationName:"clusterArns" type:"list"` // The nextToken value to include in a future ListClusters request. When the @@ -14587,20 +14749,19 @@ type ListContainerInstancesInput struct { // in the Amazon Elastic Container Service Developer Guide. Filter *string `locationName:"filter" type:"string"` - // The maximum number of container instance results returned by ListContainerInstances - // in paginated output. When this parameter is used, ListContainerInstances + // The maximum number of container instance results that ListContainerInstances + // returned in paginated output. When this parameter is used, ListContainerInstances // 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 ListContainerInstances request with the returned nextToken value. - // This value can be between 1 and 100. If this parameter is not used, then - // ListContainerInstances returns up to 100 results and a nextToken value if - // applicable. + // This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances + // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListContainerInstances request indicating // that more results are available to fulfill the request and further calls - // will be needed. If maxResults was provided, it is possible the number of - // results to be fewer than maxResults. + // are needed. If maxResults was provided, it's possible the number of results + // to be fewer than maxResults. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. @@ -14608,7 +14769,7 @@ type ListContainerInstancesInput struct { // Filters the container instances by status. For example, if you specify the // DRAINING status, the results include only container instances that have been - // set to DRAINING using UpdateContainerInstancesState. If you do not specify + // set to DRAINING using UpdateContainerInstancesState. If you don't specify // this parameter, the default is to include container instances set to all // states other than INACTIVE. Status *string `locationName:"status" type:"string" enum:"ContainerInstanceStatus"` @@ -14717,12 +14878,12 @@ type ListServicesInput struct { // The launch type to use when filtering the ListServices results. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // The maximum number of service results returned by ListServices in paginated + // The maximum number of service results that ListServices returned in paginated // output. When this parameter is used, ListServices 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 ListServices // request with the returned nextToken value. This value can be between 1 and - // 100. If this parameter is not used, then ListServices returns up to 10 results + // 100. If this parameter isn't used, then ListServices returns up to 10 results // and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -14796,8 +14957,8 @@ type ListServicesOutput struct { // more results to return. NextToken *string `locationName:"nextToken" type:"string"` - // The list of full ARN entries for each service associated with the specified - // cluster. + // The list of full ARN entries for each service that's associated with the + // specified cluster. ServiceArns []*string `locationName:"serviceArns" type:"list"` } @@ -14834,9 +14995,9 @@ func (s *ListServicesOutput) SetServiceArns(v []*string) *ListServicesOutput { type ListTagsForResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the resource for which to - // list the tags. Currently, the supported resources are Amazon ECS tasks, services, - // task definitions, clusters, and container instances. + // The Amazon Resource Name (ARN) that identifies the resource to list the tags + // for. Currently, the supported resources are Amazon ECS tasks, services, task + // definitions, clusters, and container instances. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` @@ -14913,19 +15074,18 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput type ListTaskDefinitionFamiliesInput struct { _ struct{} `type:"structure"` - // The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. + // The familyPrefix is a string that's used to filter the results of ListTaskDefinitionFamilies. // If you specify a familyPrefix, only task definition family names that begin // with the familyPrefix string are returned. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` - // The maximum number of task definition family results returned by ListTaskDefinitionFamilies - // in paginated output. When this parameter is used, ListTaskDefinitions only - // returns maxResults results in a single page along with a nextToken response + // The maximum number of task definition family results that ListTaskDefinitionFamilies + // returned in paginated output. When this parameter is used, ListTaskDefinitions + // 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 ListTaskDefinitionFamilies request with the returned nextToken value. - // This value can be between 1 and 100. If this parameter is not used, then - // ListTaskDefinitionFamilies returns up to 100 results and a nextToken value - // if applicable. + // This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies + // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListTaskDefinitionFamilies request indicating @@ -14937,9 +15097,9 @@ type ListTaskDefinitionFamiliesInput struct { // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` - // The task definition family status with which to filter the ListTaskDefinitionFamilies - // results. By default, both ACTIVE and INACTIVE task definition families are - // listed. If this parameter is set to ACTIVE, only task definition families + // The task definition family status to filter the ListTaskDefinitionFamilies + // results with. By default, both ACTIVE and INACTIVE task definition families + // are listed. If this parameter is set to ACTIVE, only task definition families // that have an ACTIVE task definition revision are returned. If this parameter // is set to INACTIVE, only task definition families that do not have any ACTIVE // task definition revisions are returned. If you paginate the resulting output, @@ -15036,17 +15196,17 @@ func (s *ListTaskDefinitionFamiliesOutput) SetNextToken(v string) *ListTaskDefin type ListTaskDefinitionsInput struct { _ struct{} `type:"structure"` - // The full family name with which to filter the ListTaskDefinitions results. - // Specifying a familyPrefix limits the listed task definitions to task definition - // revisions that belong to that family. + // The full family name to filter the ListTaskDefinitions results with. Specifying + // a familyPrefix limits the listed task definitions to task definition revisions + // that belong to that family. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` - // The maximum number of task definition results returned by ListTaskDefinitions + // The maximum number of task definition results that ListTaskDefinitions returned // in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This - // value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions + // value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -15059,15 +15219,15 @@ type ListTaskDefinitionsInput struct { // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` - // The order in which to sort the results. Valid values are ASC and DESC. By - // default (ASC), task definitions are listed lexicographically by family name - // and in ascending numerical order by revision so that the newest task definitions + // The order to sort the results in. Valid values are ASC and DESC. By default, + // (ASC) task definitions are listed lexicographically by family name and in + // ascending numerical order by revision so that the newest task definitions // in a family are listed last. Setting this parameter to DESC reverses the - // sort order on family name and revision so that the newest task definitions + // sort order on family name and revision. This is so that the newest task definitions // in a family are listed first. Sort *string `locationName:"sort" type:"string" enum:"SortOrder"` - // The task definition status with which to filter the ListTaskDefinitions results. + // The task definition status to filter the ListTaskDefinitions results with. // By default, only ACTIVE task definitions are listed. By setting this parameter // to INACTIVE, you can view task definitions that are INACTIVE as long as an // active task or service still references them. If you paginate the resulting @@ -15183,13 +15343,13 @@ type ListTasksInput struct { // The task desired status to use when filtering the ListTasks results. Specifying // a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has // set the desired status to STOPPED. This can be useful for debugging tasks - // that are not starting properly or have died or finished. The default status + // that aren't starting properly or have died or finished. The default status // filter is RUNNING, which shows tasks that Amazon ECS has set the desired // status to RUNNING. // // Although you can filter results based on a desired status of PENDING, this - // does not return any results. Amazon ECS never sets the desired status of - // a task to that value (only a task's lastStatus may have a value of PENDING). + // doesn't return any results. Amazon ECS never sets the desired status of a + // task to that value (only a task's lastStatus may have a value of PENDING). DesiredStatus *string `locationName:"desiredStatus" type:"string" enum:"DesiredStatus"` // The name of the task definition family to use when filtering the ListTasks @@ -15200,18 +15360,18 @@ type ListTasksInput struct { // The launch type to use when filtering the ListTasks results. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // The maximum number of task results returned by ListTasks in paginated output. + // The maximum number of task results that ListTasks returned in paginated output. // When this parameter is used, ListTasks 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 ListTasks request with // the returned nextToken value. This value can be between 1 and 100. If this - // parameter is not used, then ListTasks returns up to 100 results and a nextToken + // parameter isn't used, then ListTasks returns up to 100 results and a nextToken // value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a ListTasks request indicating that more // results are available to fulfill the request and further calls will be needed. - // If maxResults was provided, it is possible the number of results to be fewer + // If maxResults was provided, it's possible the number of results to be fewer // than maxResults. // // This token should be treated as an opaque identifier that is only used to @@ -15222,7 +15382,7 @@ type ListTasksInput struct { // a serviceName limits the results to tasks that belong to that service. ServiceName *string `locationName:"serviceName" type:"string"` - // The startedBy value with which to filter the task results. Specifying a startedBy + // The startedBy value to filter the task results with. Specifying a startedBy // value limits the results to tasks that were started with that value. StartedBy *string `locationName:"startedBy" type:"string"` } @@ -15356,8 +15516,8 @@ type LoadBalancer struct { // The port on the container to associate with the load balancer. This port // must correspond to a containerPort in the task definition the tasks in the // service are using. For tasks that use the EC2 launch type, the container - // instance they are launched on must allow ingress traffic on the hostPort - // of the port mapping. + // instance they're launched on must allow ingress traffic on the hostPort of + // the port mapping. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The name of the load balancer to associate with the Amazon ECS service or @@ -15372,24 +15532,24 @@ type LoadBalancer struct { // group or groups associated with a service or task set. // // A target group ARN is only specified when using an Application Load Balancer - // or Network Load Balancer. If you are using a Classic Load Balancer the target - // group ARN should be omitted. + // or Network Load Balancer. If you're using a Classic Load Balancer, omit the + // target group ARN. // // For services using the ECS deployment controller, you can specify one or // multiple target groups. For more information, see Registering Multiple Target // Groups with a Service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) // in the Amazon Elastic Container Service Developer Guide. // - // For services using the CODE_DEPLOY deployment controller, you are required + // For services using the CODE_DEPLOY deployment controller, you're required // to define two target groups for the load balancer. For more information, // see Blue/Green Deployment with CodeDeploy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) // in the Amazon Elastic Container Service Developer Guide. // - // If your service's task definition uses the awsvpc network mode (which is - // required for the Fargate launch type), you must choose ip as the target type, - // not instance, when creating your target groups because tasks that use the - // awsvpc network mode are associated with an elastic network interface, not - // an Amazon EC2 instance. + // If your service's task definition uses the awsvpc network mode, you must + // choose ip as the target type, not instance. Do this when creating your target + // groups because tasks that use the awsvpc network mode are associated with + // an elastic network interface, not an Amazon EC2 instance. This network mode + // is required for the Fargate launch type. TargetGroupArn *string `locationName:"targetGroupArn" type:"string"` } @@ -15441,14 +15601,13 @@ func (s *LoadBalancer) SetTargetGroupArn(v string) *LoadBalancer { // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/). // // By default, containers use the same logging driver that the Docker daemon -// uses; however the container may use a different logging driver than the Docker -// daemon by specifying a log driver configuration in the container definition. -// For more information on the options for different supported log drivers, +// uses. However, the container might use a different logging driver than the +// Docker daemon by specifying a log driver configuration in the container definition. +// For more information about the options for different supported log drivers, // see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) // in the Docker documentation. // -// The following should be noted when specifying a log configuration for your -// containers: +// Understand the following when specifying a log configuration for your containers. // // * Amazon ECS currently supports a subset of the logging drivers available // to the Docker daemon (shown in the valid values below). Additional log @@ -15458,16 +15617,16 @@ func (s *LoadBalancer) SetTargetGroupArn(v string) *LoadBalancer { // * This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. // -// * For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent -// must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS +// * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container +// agent must register the available logging drivers 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. // -// * For tasks on Fargate, because you do not have access to the underlying -// infrastructure your tasks are hosted on, any additional software needed -// will have to be installed outside of the task. For example, the Fluentd +// * For tasks that are on Fargate, because you don't have access to the +// underlying infrastructure your tasks are hosted on, any additional software +// needed must be installed outside of the task. For example, the Fluentd // output aggregators or a remote host running Logstash to send Gelf logs // to. type LogConfiguration struct { @@ -15489,11 +15648,11 @@ type LogConfiguration struct { // routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) // in the Amazon Elastic Container Service Developer Guide. // - // If you have a custom driver that is not listed, you can fork the Amazon ECS - // container agent project that is available on GitHub (https://github.com/aws/amazon-ecs-agent) + // If you have a custom driver that isn't listed, you can fork the Amazon ECS + // container agent project that's available on GitHub (https://github.com/aws/amazon-ecs-agent) // and customize it to work with that driver. We encourage you to submit pull - // requests for changes that you would like to have included. However, we do - // not currently provide support for running modified copies of this software. + // requests for changes that you would like to have included. However, we don't + // currently provide support for running modified copies of this software. // // LogDriver is a required field LogDriver *string `locationName:"logDriver" type:"string" required:"true" enum:"LogDriver"` @@ -15574,7 +15733,7 @@ func (s *LogConfiguration) SetSecretOptions(v []*Secret) *LogConfiguration { type ManagedAgent struct { _ struct{} `type:"structure"` - // The Unix timestamp for when the managed agent was last started. + // The Unix timestamp for the time when the managed agent was last started. LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"` // The last known status of the managed agent. @@ -15634,7 +15793,7 @@ func (s *ManagedAgent) SetReason(v string) *ManagedAgent { type ManagedAgentStateChange struct { _ struct{} `type:"structure"` - // The name of the container associated with the managed agent. + // The name of the container that's associated with the managed agent. // // ContainerName is a required field ContainerName *string `locationName:"containerName" type:"string" required:"true"` @@ -15718,7 +15877,7 @@ func (s *ManagedAgentStateChange) SetStatus(v string) *ManagedAgentStateChange { // // When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out // actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling -// policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity +// policy using an Amazon ECS managed CloudWatch metric with the specified targetCapacity // value as the target value for the metric. For more information, see Using // Managed Scaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) // in the Amazon Elastic Container Service Developer Guide. @@ -15733,23 +15892,22 @@ type ManagedScaling struct { // is omitted, the default value of 300 seconds is used. InstanceWarmupPeriod *int64 `locationName:"instanceWarmupPeriod" type:"integer"` - // The maximum number of container instances that Amazon ECS will scale in or - // scale out at one time. If this parameter is omitted, the default value of - // 10000 is used. + // The maximum number of container instances that Amazon ECS scales in or scales + // out at one time. If this parameter is omitted, the default value of 10000 + // is used. MaximumScalingStepSize *int64 `locationName:"maximumScalingStepSize" min:"1" type:"integer"` - // The minimum number of container instances that Amazon ECS will scale in or - // scale out at one time. If this parameter is omitted, the default value of - // 1 is used. + // The minimum number of container instances that Amazon ECS scales in or scales + // out at one time. If this parameter is omitted, the default value of 1 is + // used. MinimumScalingStepSize *int64 `locationName:"minimumScalingStepSize" min:"1" type:"integer"` - // Whether or not to enable managed scaling for the capacity provider. + // Determines whether to enable managed scaling for the capacity provider. Status *string `locationName:"status" type:"string" enum:"ManagedScalingStatus"` // The target capacity value for the capacity provider. The specified value - // must be greater than 0 and less than or equal to 100. A value of 100 will - // result in the Amazon EC2 instances in your Auto Scaling group being completely - // utilized. + // must be greater than 0 and less than or equal to 100. A value of 100 results + // in the Amazon EC2 instances in your Auto Scaling group being completely used. TargetCapacity *int64 `locationName:"targetCapacity" min:"1" type:"integer"` } @@ -15820,10 +15978,10 @@ func (s *ManagedScaling) SetTargetCapacity(v int64) *ManagedScaling { return s } -// Amazon ECS is unable to determine the current version of the Amazon ECS container -// agent on the container instance and does not have enough information to proceed +// Amazon ECS can't determine the current version of the Amazon ECS container +// agent on the container instance and doesn't have enough information to proceed // with an update. This could be because the agent running on the container -// instance is an older or custom version that does not use our version information. +// instance is a previous or custom version that doesn't use our version information. type MissingVersionException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -15887,7 +16045,7 @@ func (s *MissingVersionException) RequestID() string { return s.RespMetadata.RequestID } -// Details on a volume mount point that is used in a container definition. +// Details for a volume mount point that's used in a container definition. type MountPoint struct { _ struct{} `type:"structure"` @@ -15950,10 +16108,10 @@ type NetworkBinding struct { // The IP address that the container is bound to on the container instance. BindIP *string `locationName:"bindIP" type:"string"` - // The port number on the container that is used with the network binding. + // The port number on the container that's used with the network binding. ContainerPort *int64 `locationName:"containerPort" type:"integer"` - // The port number on the host that is used with the network binding. + // The port number on the host that's used with the network binding. HostPort *int64 `locationName:"hostPort" type:"integer"` // The protocol used for the network binding. @@ -16006,7 +16164,7 @@ func (s *NetworkBinding) SetProtocol(v string) *NetworkBinding { type NetworkConfiguration struct { _ struct{} `type:"structure"` - // The VPC subnets and security groups associated with a task. + // The VPC subnets and security groups that are associated with a task. // // All specified subnets and security groups must be from the same VPC. AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"` @@ -16102,9 +16260,9 @@ func (s *NetworkInterface) SetPrivateIpv4Address(v string) *NetworkInterface { return s } -// There is no update available for this Amazon ECS container agent. This could -// be because the agent is already running the latest version, or it is so old -// that there is no update path to the current version. +// There's no update available for this Amazon ECS container agent. This might +// be because the agent is already running the latest version or because it's +// so old that there's no update path to the current version. type NoUpdateAvailableException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -16172,8 +16330,8 @@ func (s *NoUpdateAvailableException) RequestID() string { // see Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. // -// If you are using the Fargate launch type, task placement constraints are -// not supported. +// If you're using the Fargate launch type, task placement constraints aren't +// supported. type PlacementConstraint struct { _ struct{} `type:"structure"` @@ -16228,7 +16386,7 @@ type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement // strategy, valid values are instanceId (or host, which has the same effect), - // or any platform or custom attribute that is applied to a container instance, + // or any platform or custom attribute that's applied to a container instance, // such as attribute:ecs.availability-zone. For the binpack placement strategy, // valid values are cpu and memory. For the random placement strategy, this // field is not used. @@ -16238,9 +16396,9 @@ type PlacementStrategy struct { // tasks on available candidates. The spread placement strategy spreads placement // across available candidates evenly based on the field parameter. The binpack // strategy places tasks on available candidates that have the least available - // amount of the resource that is specified with the field parameter. For example, + // amount of the resource that's specified with the field parameter. For example, // if you binpack on memory, a task is placed on the instance with the least - // amount of remaining memory (but still enough to run the task). + // amount of remaining memory but still enough to run the task. Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"` } @@ -16279,15 +16437,15 @@ func (s *PlacementStrategy) SetType(v string) *PlacementStrategy { type PlatformDevice struct { _ struct{} `type:"structure"` - // The ID for the GPU(s) on the container instance. The available GPU IDs can + // The ID for the GPUs on the container instance. The available GPU IDs can // also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json // file. // // Id is a required field Id *string `locationName:"id" type:"string" required:"true"` - // The type of device that is available on the container instance. The only - // supported value is GPU. + // The type of device that's available on the container instance. The only supported + // value is GPU. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"PlatformDeviceType"` @@ -16339,8 +16497,8 @@ func (s *PlatformDevice) SetType(v string) *PlatformDevice { return s } -// The specified platform version does not satisfy the task definition's required -// capabilities. +// The specified platform version doesn't satisfy the required capabilities +// of the task definition. type PlatformTaskDefinitionIncompatibilityException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -16404,7 +16562,7 @@ func (s *PlatformTaskDefinitionIncompatibilityException) RequestID() string { return s.RespMetadata.RequestID } -// The specified platform version does not exist. +// The specified platform version doesn't exist. type PlatformUnknownException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -16472,12 +16630,12 @@ func (s *PlatformUnknownException) RequestID() string { // to send or receive traffic. Port mappings are specified as part of the container // definition. // -// If you are using containers in a task with the awsvpc or host network mode, -// exposed ports should be specified using containerPort. The hostPort can be -// left blank or it must be the same value as the containerPort. +// If you use containers in a task with the awsvpc or host network mode, specify +// the exposed ports using containerPort. The hostPort can be left blank or +// it must be the same value as the containerPort. // -// You cannot expose the same container port for multiple protocols. An error -// will be returned if this is attempted +// You can't expose the same container port for multiple protocols. If you attempt +// this, an error is returned. // // After a task reaches the RUNNING status, manual and automatic host and container // port assignments are visible in the networkBindings section of DescribeTasks @@ -16485,29 +16643,29 @@ func (s *PlatformUnknownException) RequestID() string { type PortMapping struct { _ struct{} `type:"structure"` - // The port number on the container that is bound to the user-specified or automatically + // The port number on the container that's bound to the user-specified or automatically // assigned host port. // - // If you are using containers in a task with the awsvpc or host network mode, - // exposed ports should be specified using containerPort. + // If you use containers in a task with the awsvpc or host network mode, specify + // the exposed ports using containerPort. // - // If you are using containers in a task with the bridge network mode and you - // specify a container port and not a host port, your container automatically - // receives a host port in the ephemeral port range. For more information, see - // hostPort. Port mappings that are automatically assigned in this way do not - // count toward the 100 reserved ports limit of a container instance. + // If you use containers in a task with the bridge network mode and you specify + // a container port and not a host port, your container automatically receives + // a host port in the ephemeral port range. For more information, see hostPort. + // Port mappings that are automatically assigned in this way do not count toward + // the 100 reserved ports limit of a container instance. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the container instance to reserve for your container. // - // If you are using containers in a task with the awsvpc or host network mode, - // the hostPort can either be left blank or set to the same value as the containerPort. + // If you use containers in a task with the awsvpc or host network mode, the + // hostPort can either be left blank or set to the same value as the containerPort. // - // If you are using containers in a task with the bridge network mode, you can - // specify a non-reserved host port for your container port mapping, or you - // can omit the hostPort (or set it to 0) while specifying a containerPort and - // your container automatically receives a port in the ephemeral port range - // for your container instance operating system and Docker version. + // If you use containers in a task with the bridge network mode, you can specify + // a non-reserved host port for your container port mapping, or you can omit + // the hostPort (or set it to 0) while specifying a containerPort and your container + // automatically receives a port in the ephemeral port range for your container + // instance operating system and Docker version. // // The default ephemeral port range for Docker version 1.6.0 and later is listed // on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel @@ -16522,11 +16680,11 @@ type PortMapping struct { // The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, // and the Amazon ECS container agent ports 51678-51680. Any host port that // was previously specified in a running task is also reserved while the task - // is running (after a task stops, the host port is released). The current reserved - // ports are displayed in the remainingResources of DescribeContainerInstances - // output. A container instance can have up to 100 reserved ports at a time, - // including the default reserved ports. Automatically assigned ports don't - // count toward the 100 reserved ports limit. + // is running. That is, after a task stops, the host port is released. The current + // reserved ports are displayed in the remainingResources of DescribeContainerInstances + // output. A container instance can have up to 100 reserved ports at a time. + // This number includes the default reserved ports. Automatically assigned ports + // aren't included in the 100 reserved ports quota. HostPort *int64 `locationName:"hostPort" type:"integer"` // The protocol used for the port mapping. Valid values are tcp and udp. The @@ -16572,12 +16730,12 @@ func (s *PortMapping) SetProtocol(v string) *PortMapping { // The configuration details for the App Mesh proxy. // -// For tasks using the EC2 launch type, the container instances require at least -// version 1.26.0 of the container agent and at least version 1.26.0-1 of the -// ecs-init package to enable a proxy configuration. If your container instances -// are launched from the Amazon ECS-optimized AMI version 20190301 or later, -// then they contain the required versions of the container agent and ecs-init. -// For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) +// For tasks that use the EC2 launch type, the container instances require at +// least version 1.26.0 of the container agent and at least version 1.26.0-1 +// of the ecs-init package to enable a proxy configuration. If your container +// instances are launched from the Amazon ECS optimized AMI version 20190301 +// or later, then they contain the required versions of the container agent +// and ecs-init. For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) type ProxyConfiguration struct { _ struct{} `type:"structure"` @@ -16889,7 +17047,7 @@ type PutAttributesInput struct { _ struct{} `type:"structure"` // The attributes to apply to your resource. You can specify up to 10 custom - // attributes per resource. You can specify up to 10 attributes in a single + // attributes for each resource. You can specify up to 10 attributes in a single // call. // // Attributes is a required field @@ -17002,8 +17160,8 @@ type PutClusterCapacityProvidersInput struct { CapacityProviders []*string `locationName:"capacityProviders" type:"list" required:"true"` // The short name or full Amazon Resource Name (ARN) of the cluster to modify - // the capacity provider settings for. If you do not specify a cluster, the - // default cluster is assumed. + // the capacity provider settings for. If you don't specify a cluster, the default + // cluster is assumed. // // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` @@ -17134,9 +17292,9 @@ type RegisterContainerInstanceInput struct { // The container instance attributes that this container instance supports. Attributes []*Attribute `locationName:"attributes" type:"list"` - // The short name or full Amazon Resource Name (ARN) of the cluster with which - // to register your container instance. If you do not specify a cluster, the - // default cluster is assumed. + // The short name or full Amazon Resource Name (ARN) of the cluster to register + // your container instance with. If you do not specify a cluster, the default + // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The ARN of the container instance (if it was previously registered). @@ -17156,8 +17314,8 @@ type RegisterContainerInstanceInput struct { PlatformDevices []*PlatformDevice `locationName:"platformDevices" type:"list"` // The metadata that you apply to the container instance to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // and organize them. Each tag consists of a key and an optional value. You + // define both. // // The following basic restrictions apply to tags: // @@ -17187,7 +17345,7 @@ type RegisterContainerInstanceInput struct { TotalResources []*Resource `locationName:"totalResources" type:"list"` // The version information for the Amazon ECS container agent and Docker daemon - // running on the container instance. + // that runs on the container instance. VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"` } @@ -17344,20 +17502,23 @@ type RegisterTaskDefinitionInput struct { ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list" required:"true"` // The number of CPU units used by the task. It can be expressed as an integer - // using CPU units, for example 1024, or as a string using vCPUs, for example - // 1 vCPU or 1 vcpu, in a task definition. String values are converted to an + // using CPU units (for example, 1024) or as a string using vCPUs (for example, + // 1 vCPU or 1 vcpu) in a task definition. String values are converted to an // integer indicating the CPU units when the task definition is registered. // // Task-level CPU and memory parameters are ignored for Windows containers. // We recommend specifying container-level resources for Windows containers. // - // If you are using the EC2 launch type, this field is optional. Supported values + // If you're using the EC2 launch type, this field is optional. Supported values // are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported + // If you're using the Fargate launch type, this field is required and you must + // use one of the following values, which determines your range of supported // values for the memory parameter: // + // The CPU units cannot be less than 1 vCPU when you use Windows containers + // on Fargate. + // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) // @@ -17396,10 +17557,10 @@ type RegisterTaskDefinitionInput struct { // in the Amazon Elastic Container Service Developer Guide. ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"` - // You must specify a family for a task definition, which allows you to track - // multiple versions of the same task definition. The family is used as a name - // for your task definition. Up to 255 letters (uppercase and lowercase), numbers, - // underscores, and hyphens are allowed. + // You must specify a family for a task definition. You can use it track multiple + // versions of the same task definition. The family is used as a name for your + // task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, + // and hyphens are allowed. // // Family is a required field Family *string `locationName:"family" type:"string" required:"true"` @@ -17438,8 +17599,8 @@ type RegisterTaskDefinitionInput struct { IpcMode *string `locationName:"ipcMode" type:"string" enum:"IpcMode"` // The amount of memory (in MiB) used by the task. It can be expressed as an - // integer using MiB, for example 1024, or as a string using GB, for example - // 1GB or 1 GB, in a task definition. String values are converted to an integer + // integer using MiB (for example ,1024) or as a string using GB (for example, + // 1GB or 1 GB) in a task definition. String values are converted to an integer // indicating the MiB when the task definition is registered. // // Task-level CPU and memory parameters are ignored for Windows containers. @@ -17448,8 +17609,11 @@ type RegisterTaskDefinitionInput struct { // If using the EC2 launch type, this field is optional. // // If using the Fargate launch type, this field is required and you must use - // one of the following values, which determines your range of supported values - // for the cpu parameter: + // one of the following values. This determines your range of supported values + // for the cpu parameter. + // + // The CPU units cannot be less than 1 vCPU when you use Windows containers + // on Fargate. // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) @@ -17518,8 +17682,8 @@ type RegisterTaskDefinitionInput struct { PidMode *string `locationName:"pidMode" type:"string" enum:"PidMode"` // An array of placement constraint objects to use for the task. You can specify - // a maximum of 10 constraints per task (this limit includes constraints in - // the task definition and those specified at runtime). + // a maximum of 10 constraints for each task. This limit includes constraints + // in the task definition and those specified at runtime. PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The configuration details for the App Mesh proxy. @@ -17534,10 +17698,10 @@ type RegisterTaskDefinitionInput struct { // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"` - // The task launch type that Amazon ECS should validate the task definition - // against. A client exception is returned if the task definition doesn't validate - // against the compatibilities specified. If no value is specified, the parameter - // is omitted from the response. + // The task launch type that Amazon ECS validates the task definition against. + // A client exception is returned if the task definition doesn't validate against + // the compatibilities specified. If no value is specified, the parameter is + // omitted from the response. RequiresCompatibilities []*string `locationName:"requiresCompatibilities" type:"list"` // The operating system that your tasks definitions run on. A platform family @@ -17548,8 +17712,8 @@ type RegisterTaskDefinitionInput struct { RuntimePlatform *RuntimePlatform `locationName:"runtimePlatform" type:"structure"` // The metadata that you apply to the task definition to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // and organize them. Each tag consists of a key and an optional value. You + // define both of them. // // The following basic restrictions apply to tags: // @@ -17583,7 +17747,7 @@ type RegisterTaskDefinitionInput struct { TaskRoleArn *string `locationName:"taskRoleArn" type:"string"` // A list of volume definitions in JSON format that containers in your task - // may use. + // might use. Volumes []*Volume `locationName:"volumes" type:"list"` } @@ -17820,11 +17984,10 @@ type RepositoryCredentials struct { // The Amazon Resource Name (ARN) of the secret containing the private repository // credentials. // - // When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if - // the secret exists in the same Region as the task that you are launching then - // you can use either the full ARN or the name of the secret. When you are using - // the Amazon Web Services Management Console, you must specify the full ARN - // of the secret. + // When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the + // secret exists in the same Region as the task that you're launching then you + // can use either the full ARN or the name of the secret. When you use the Amazon + // Web Services Management Console, you must specify the full ARN of the secret. // // CredentialsParameter is a required field CredentialsParameter *string `locationName:"credentialsParameter" type:"string" required:"true"` @@ -17890,7 +18053,7 @@ type Resource struct { // string type. StringSetValue []*string `locationName:"stringSetValue" type:"list"` - // The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. + // The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET. Type *string `locationName:"type" type:"string"` } @@ -17948,7 +18111,7 @@ func (s *Resource) SetType(v string) *Resource { return s } -// The specified resource is in-use and cannot be removed. +// The specified resource is in-use and can't be removed. type ResourceInUseException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18012,7 +18175,7 @@ func (s *ResourceInUseException) RequestID() string { return s.RespMetadata.RequestID } -// The specified resource could not be found. +// The specified resource wasn't found. type ResourceNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18093,11 +18256,11 @@ type ResourceRequirement struct { // The value for the specified resource type. // // If the GPU type is used, the value is the number of physical GPUs the Amazon - // ECS container agent will reserve for the container. The number of GPUs reserved - // for all containers in a task should not exceed the number of available GPUs - // on the container instance the task is launched on. + // ECS container agent reserves for the container. The number of GPUs that's + // reserved for all containers in a task can't exceed the number of available + // GPUs on the container instance that the task is launched on. // - // If the InferenceAccelerator type is used, the value should match the deviceName + // If the InferenceAccelerator type is used, the value matches the deviceName // for an InferenceAccelerator specified in a task definition. // // Value is a required field @@ -18165,13 +18328,12 @@ type RunTaskInput struct { // A capacity provider strategy may contain a maximum of 6 capacity providers. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` - // The short name or full Amazon Resource Name (ARN) of the cluster on which - // to run your task. If you do not specify a cluster, the default cluster is - // assumed. + // The short name or full Amazon Resource Name (ARN) of the cluster to run your + // task on. If you do not specify a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The number of instantiations of the specified task to place on your cluster. - // You can specify up to 10 tasks per call. + // You can specify up to 10 tasks for each call. Count *int64 `locationName:"count" type:"integer"` // Specifies whether to enable Amazon ECS managed tags for the task. For more @@ -18179,7 +18341,7 @@ type RunTaskInput struct { // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // Whether or not to enable the execute command functionality for the containers + // Determines whether to enable the execute command functionality for the containers // in this task. If true, this enables execute command functionality on all // containers in the task. EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"` @@ -18188,7 +18350,7 @@ type RunTaskInput struct { // is the family name of the task definition (for example, family:my-family-name). Group *string `locationName:"group" type:"string"` - // The infrastructure on which to run your standalone task. For more information, + // The infrastructure to run your standalone task on. For more information, // see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. // @@ -18202,7 +18364,7 @@ type RunTaskInput struct { // The EC2 launch type runs your tasks on Amazon EC2 instances registered to // your cluster. // - // The EXTERNAL launch type runs your tasks on your on-premise server or virtual + // The EXTERNAL launch type runs your tasks on your on-premises server or virtual // machine (VM) capacity registered to your cluster. // // A task can use either a launch type or a capacity provider strategy. If a @@ -18214,14 +18376,14 @@ type RunTaskInput struct { // The network configuration for the task. This parameter is required for task // definitions that use the awsvpc network mode to receive their own elastic - // network interface, and it is not supported for other network modes. For more + // network interface, and it isn't supported for other network modes. For more // information, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // A list of container overrides in JSON format that specify the name of a container // in the specified task definition and the overrides it should receive. You - // can override the default command for a container (that is specified in the + // can override the default command for a container (that's specified in the // task definition or Docker image) with a command override. You can also override // existing environment variables (that are specified in the task definition // or Docker image) on a container or add new environment variables to it with @@ -18232,23 +18394,22 @@ type RunTaskInput struct { Overrides *TaskOverride `locationName:"overrides" type:"structure"` // An array of placement constraint objects to use for the task. You can specify - // up to 10 constraints per task (including constraints in the task definition + // up to 10 constraints for each task (including constraints in the task definition // and those specified at runtime). PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for the task. You can specify a maximum - // of 5 strategy rules per task. + // of 5 strategy rules for each task. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The platform version the task should use. A platform version is only specified - // for tasks hosted on Fargate. If one is not specified, the LATEST platform - // version is used by default. For more information, see Fargate platform versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version the task uses. A platform version is only specified + // for tasks hosted on Fargate. If one isn't specified, the LATEST platform + // version is used. 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"` // Specifies whether to propagate the tags from the task definition to the task. - // If no value is specified, the tags are not propagated. Tags can only be propagated + // If no value is specified, the tags aren't propagated. Tags can only be propagated // to the task during task creation. To add tags to a task after task creation, // use the TagResource API action. // @@ -18265,7 +18426,7 @@ type RunTaskInput struct { // for that job to your task with the startedBy parameter. You can then identify // which tasks belong to that job by filtering the results of a ListTasks call // with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, - // hyphens, and underscores are allowed. + // hyphens (-), and underscores (_) are allowed. // // If a task is started by an Amazon ECS service, then the startedBy parameter // contains the deployment ID of the service that starts it. @@ -18300,9 +18461,9 @@ type RunTaskInput struct { Tags []*Tag `locationName:"tags" type:"list"` // The family and revision (family:revision) or full ARN of the task definition - // to run. If a revision is not specified, the latest ACTIVE revision is used. + // to run. If a revision isn't specified, the latest ACTIVE revision is used. // - // The full ARN value must match the value that you specified ias the Resource + // The full ARN value must match the value that you specified as the Resource // of the IAM principal's permissions policy. For example, if the Resource is // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the // taskDefinition ARN value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName. @@ -18623,7 +18784,7 @@ type Secret struct { // the SSM Parameter Store. // // If the SSM Parameter Store parameter exists in the same Region as the task - // you are launching, then you can use either the full ARN or name of the parameter. + // 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. // @@ -18745,14 +18906,14 @@ func (s *ServerException) RequestID() string { type Service struct { _ struct{} `type:"structure"` - // The capacity provider strategy the service is using. When using the DescribeServices + // The capacity provider strategy the service uses. When using the DescribeServices // API, this field is omitted if the service was created using a launch type. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` // The Amazon Resource Name (ARN) of the cluster that hosts the service. ClusterArn *string `locationName:"clusterArn" type:"string"` - // The Unix timestamp for when the service was created. + // The Unix timestamp for the time when the service was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The principal that created the service. @@ -18763,7 +18924,7 @@ type Service struct { DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` // The deployment controller type the service is using. When using the DescribeServices - // API, this field is omitted if the service is using the ECS deployment controller + // API, this field is omitted if the service uses the ECS deployment controller // type. DeploymentController *DeploymentController `locationName:"deploymentController" type:"structure"` @@ -18775,12 +18936,12 @@ type Service struct { // CreateService, and it can be modified with UpdateService. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` - // Specifies whether to enable Amazon ECS managed tags for the tasks in the + // Determines whether to enable Amazon ECS managed tags for the tasks in the // service. For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` - // Whether or not the execute command functionality is enabled for the service. + // Determines whether the execute command functionality is enabled for the service. // If true, the execute command functionality is enabled for all containers // in tasks as part of the service. EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"` @@ -18799,9 +18960,9 @@ type Service struct { // strategy. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // A list of Elastic Load Balancing load balancer objects, containing the load - // balancer name, the container name (as it appears in a container definition), - // and the container port to access from the load balancer. + // A list of Elastic Load Balancing load balancer objects. It contains the load + // balancer name, the container name, and the container port to access from + // the load balancer. The container name is as it appears in a container definition. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The VPC subnet and security group configuration for tasks that receive their @@ -18817,27 +18978,27 @@ type Service struct { // The placement strategy that determines how tasks for the service are placed. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The operating system that your tasks in the service are running on. A platform - // family is specified only for tasks using the Fargate launch type. + // The operating system that your tasks in the service run on. A platform family + // is specified only for tasks using the Fargate launch type. // // All tasks that run as part of this service must use the same platformFamily - // value as the service, for example, LINUX. + // value as the service (for example, LINUX). PlatformFamily *string `locationName:"platformFamily" type:"string"` - // The platform version on which to run your service. A platform version is - // only specified for tasks hosted on Fargate. If one is not specified, the - // LATEST platform version is used by default. For more information, see Fargate - // Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version to run your service on. A platform version is only specified + // for tasks that are hosted on Fargate. If one isn't specified, the LATEST + // platform version is used. 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"` - // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. + // Determines whether to propagate the tags from the task definition or the + // service to the task. If no value is specified, the tags aren't propagated. PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` - // The ARN of the IAM role associated with the service that allows the Amazon - // ECS container agent to register container instances with an Elastic Load - // Balancing load balancer. + // The ARN of the IAM role that's associated with the service. It allows the + // Amazon ECS container agent to register container instances with an Elastic + // Load Balancing load balancer. RoleArn *string `locationName:"roleArn" type:"string"` // The number of tasks in the cluster that are in the RUNNING state. @@ -18846,7 +19007,7 @@ type Service struct { // The scheduling strategy to use for the service. For more information, see // Services (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). // - // There are two service scheduler strategies available: + // There are two service scheduler strategies available. // // * REPLICA-The replica scheduling strategy places and maintains the desired // number of tasks across your cluster. By default, the service scheduler @@ -18854,11 +19015,11 @@ type Service struct { // and constraints to customize task placement decisions. // // * DAEMON-The daemon scheduling strategy deploys exactly one task on each - // active container instance that meets all of the task placement constraints + // active container instance. This taskmeets all of the task placement constraints // that you specify in your cluster. The service scheduler also evaluates - // the task placement constraints for running tasks and will stop tasks that - // do not meet the placement constraints. Fargate tasks do not support the - // DAEMON scheduling strategy. + // the task placement constraints for running tasks. It stop tasks that don't + // meet the placement constraints. Fargate tasks don't support the DAEMON + // scheduling strategy. SchedulingStrategy *string `locationName:"schedulingStrategy" type:"string" enum:"SchedulingStrategy"` // The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, @@ -18869,11 +19030,11 @@ type Service struct { // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, // underscores, and hyphens are allowed. Service names must be unique within - // a cluster, but you can have similarly named services in multiple clusters + // a cluster. However, you can have similarly named services in multiple clusters // within a Region or across multiple Regions. ServiceName *string `locationName:"serviceName" type:"string"` - // The details of the service discovery registries to assign to this service. + // The details for the service discovery registries to assign to this service. // For more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"` @@ -18881,8 +19042,8 @@ type Service struct { Status *string `locationName:"status" type:"string"` // The metadata that you apply to the service to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. + // them. Each tag consists of a key and an optional value. You define bot the + // key and value. // // The following basic restrictions apply to tags: // @@ -19124,14 +19285,14 @@ func (s *Service) SetTaskSets(v []*TaskSet) *Service { return s } -// Details on an event associated with a service. +// The details for an event that's associated with a service. type ServiceEvent struct { _ struct{} `type:"structure"` - // The Unix timestamp for when the event was triggered. + // The Unix timestamp for the time when the event was triggered. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The ID string of the event. + // The ID string for the event. Id *string `locationName:"id" type:"string"` // The event message. @@ -19174,7 +19335,7 @@ func (s *ServiceEvent) SetMessage(v string) *ServiceEvent { return s } -// The specified service is not active. You can't update a service that is inactive. +// The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. type ServiceNotActiveException struct { _ struct{} `type:"structure"` @@ -19239,8 +19400,8 @@ func (s *ServiceNotActiveException) RequestID() string { return s.RespMetadata.RequestID } -// The specified service could not be found. You can view your available services -// with ListServices. Amazon ECS services are cluster-specific and Region-specific. +// The specified service wasn't found. You can view your available services +// with ListServices. Amazon ECS services are cluster specific and Region specific. type ServiceNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -19304,31 +19465,32 @@ func (s *ServiceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Details of the service registry. +// The details for the service registry. type ServiceRegistry struct { _ struct{} `type:"structure"` - // The container name value, already specified in the task definition, to be - // used for your service discovery service. If the task definition that your + // The container name value to be used for your service discovery service. It's + // already specified in the task definition. If the task definition that your // service task specifies uses the bridge or host network mode, you must specify // a containerName and containerPort combination from the task definition. If // the task definition that your service task specifies uses the awsvpc network // mode and a type SRV DNS record is used, you must specify either a containerName - // and containerPort combination or a port value, but not both. + // and containerPort combination or a port value. However, you can't specify + // both. ContainerName *string `locationName:"containerName" type:"string"` - // The port value, already specified in the task definition, to be used for - // your service discovery service. If the task definition your service task + // The port value to be used for your service discovery service. It's already + // specified in the task definition. If the task definition your service task // specifies uses the bridge or host network mode, you must specify a containerName // and containerPort combination from the task definition. If the task definition // your service task specifies uses the awsvpc network mode and a type SRV DNS // record is used, you must specify either a containerName and containerPort - // combination or a port value, but not both. + // combination or a port value. However, you can't specify both. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port value used if your service discovery service specified an SRV record. - // This field may be used if both the awsvpc network mode and SRV records are - // used. + // This field might be used if both the awsvpc network mode and SRV records + // are used. Port *int64 `locationName:"port" type:"integer"` // The Amazon Resource Name (ARN) of the service registry. The currently supported @@ -19378,7 +19540,7 @@ func (s *ServiceRegistry) SetRegistryArn(v string) *ServiceRegistry { return s } -// The details of the execute command session. +// The details for the execute command session. type Session struct { _ struct{} `type:"structure"` @@ -19389,8 +19551,8 @@ type Session struct { // client uses to send commands and receive output from the container. StreamUrl *string `locationName:"streamUrl" type:"string"` - // An encrypted token value containing session and caller information. Used - // to authenticate the connection to the container. + // An encrypted token value containing session and caller information. It's + // used to authenticate the connection to the container. // // TokenValue is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Session's @@ -19441,11 +19603,12 @@ type Setting struct { // The Amazon ECS resource name. Name *string `locationName:"name" type:"string" enum:"SettingName"` - // The ARN of the principal, which can be an IAM user, IAM role, or the root - // user. If this field is omitted, the authenticated user is assumed. + // The ARN of the principal. It can be an IAM user, IAM role, or the root user. + // If this field is omitted, the authenticated user is assumed. PrincipalArn *string `locationName:"principalArn" type:"string"` - // Whether the account setting is enabled or disabled for the specified resource. + // Determines whether the account setting is enabled or disabled for the specified + // resource. Value *string `locationName:"value" type:"string"` } @@ -19488,13 +19651,13 @@ func (s *Setting) SetValue(v string) *Setting { type StartTaskInput struct { _ struct{} `type:"structure"` - // The short name or full Amazon Resource Name (ARN) of the cluster on which - // to start your task. If you do not specify a cluster, the default cluster - // is assumed. + // The short name or full Amazon Resource Name (ARN) of the cluster where to + // start your task. If you do not specify a cluster, the default cluster is + // assumed. Cluster *string `locationName:"cluster" type:"string"` // The container instance IDs or full ARN entries for the container instances - // on which you would like to place your task. You can specify up to 10 container + // where you would like to place your task. You can specify up to 10 container // instances. // // ContainerInstances is a required field @@ -19519,19 +19682,19 @@ type StartTaskInput struct { NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // A list of container overrides in JSON format that specify the name of a container - // in the specified task definition and the overrides it should receive. You - // can override the default command for a container (that is specified in the - // task definition or Docker image) with a command override. You can also override - // existing environment variables (that are specified in the task definition - // or Docker image) on a container or add new environment variables to it with - // an environment override. + // in the specified task definition and the overrides it receives. You can override + // the default command for a container (that's specified in the task definition + // or Docker image) with a command override. You can also override existing + // environment variables (that are specified in the task definition or Docker + // image) on a container or add new environment variables to it with an environment + // override. // // A total of 8192 characters are allowed for overrides. This limit includes // the JSON formatting characters of the override structure. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // Specifies whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags are not propagated. + // to the task. If no value is specified, the tags aren't propagated. PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` // The reference ID to use for the task. @@ -19542,10 +19705,10 @@ type StartTaskInput struct { // for that job to your task with the startedBy parameter. You can then identify // which tasks belong to that job by filtering the results of a ListTasks call // with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, - // hyphens, and underscores are allowed. + // hyphens (-), and underscores (_) are allowed. // - // If a task is started by an Amazon ECS service, then the startedBy parameter - // contains the deployment ID of the service that starts it. + // If a task is started by an Amazon ECS service, the startedBy parameter contains + // the deployment ID of the service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` // The metadata that you apply to the task to help you categorize and organize @@ -19577,7 +19740,7 @@ type StartTaskInput struct { Tags []*Tag `locationName:"tags" type:"list"` // The family and revision (family:revision) or full ARN of the task definition - // to start. If a revision is not specified, the latest ACTIVE revision is used. + // to start. If a revision isn't specified, the latest ACTIVE revision is used. // // TaskDefinition is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` @@ -19758,8 +19921,8 @@ type StopTaskInput struct { // assumed. Cluster *string `locationName:"cluster" type:"string"` - // An optional message specified when a task is stopped. For example, if you - // are using a custom scheduler, you can use this parameter to specify the reason + // An optional message specified when a task is stopped. For example, if you're + // using a custom scheduler, you can use this parameter to specify the reason // for stopping the task here, and the message appears in subsequent DescribeTasks // API operations on this task. Up to 255 characters are allowed in this message. Reason *string `locationName:"reason" type:"string"` @@ -19956,7 +20119,7 @@ type SubmitContainerStateChangeInput struct { // The name of the container. ContainerName *string `locationName:"containerName" type:"string"` - // The exit code returned for the state change request. + // The exit code that's returned for the state change request. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The network bindings of the container. @@ -20083,19 +20246,19 @@ type SubmitTaskStateChangeInput struct { // the task. Cluster *string `locationName:"cluster" type:"string"` - // Any containers associated with the state change request. + // Any containers that's associated with the state change request. Containers []*ContainerStateChange `locationName:"containers" type:"list"` - // The Unix timestamp for when the task execution stopped. + // The Unix timestamp for the time when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"` - // The details for the managed agent associated with the task. + // The details for the managed agent that's associated with the task. ManagedAgents []*ManagedAgentStateChange `locationName:"managedAgents" type:"list"` - // The Unix timestamp for when the container image pull began. + // The Unix timestamp for the time when the container image pull started. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"` - // The Unix timestamp for when the container image pull completed. + // The Unix timestamp for the time when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"` // The reason for the state change request. @@ -20252,25 +20415,25 @@ func (s *SubmitTaskStateChangeOutput) SetAcknowledgment(v string) *SubmitTaskSta // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) // and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration). // -// It is not recommended that you specify network-related systemControls parameters -// for multiple containers in a single task that also uses either the awsvpc -// or host network mode for the following reasons: +// We don't recommend that you specify network-related systemControls parameters +// for multiple containers in a single task. This task also uses either the +// awsvpc or host network mode. It does it for the following reasons. // // * For tasks that use the awsvpc network mode, if you set systemControls // for any container, it applies to all containers in the task. If you set // different systemControls for multiple containers in a single task, the -// container that is started last determines which systemControls take effect. +// container that's started last determines which systemControls take effect. // // * For tasks that use the host network mode, the systemControls parameter -// applies to the container instance's kernel parameter as well as that of -// all containers of any tasks running on that container instance. +// applies to the container instance's kernel parameter and that of all containers +// of any tasks running on that container instance. type SystemControl struct { _ struct{} `type:"structure"` - // The namespaced kernel parameter for which to set a value. + // The namespaced kernel parameter to set a value for. Namespace *string `locationName:"namespace" type:"string"` - // The value for the namespaced kernel parameter specified in namespace. + // The value for the namespaced kernel parameter that's specified in namespace. Value *string `locationName:"value" type:"string"` } @@ -20305,8 +20468,7 @@ func (s *SystemControl) SetValue(v string) *SystemControl { } // The metadata that you apply to a resource to help you categorize and organize -// them. Each tag consists of a key and an optional value, both of which you -// define. +// them. Each tag consists of a key and an optional value. You define them. // // The following basic restrictions apply to tags: // @@ -20388,7 +20550,7 @@ func (s *Tag) SetValue(v string) *Tag { type TagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, + // The Amazon Resource Name (ARN) of the resource to add tags to. Currently, // the supported resources are Amazon ECS capacity providers, tasks, services, // task definitions, clusters, and container instances. // @@ -20502,8 +20664,8 @@ func (s TagResourceOutput) GoString() string { return s.String() } -// The target container is not properly configured with the execute command -// agent or the container is no longer active or running. +// The target container isn't properly configured with the execute command agent +// or the container is no longer active or running. type TargetNotConnectedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -20567,7 +20729,7 @@ func (s *TargetNotConnectedException) RequestID() string { return s.RespMetadata.RequestID } -// The specified target could not be found. You can view your available container +// The specified target wasn't found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are // cluster-specific and Region-specific. type TargetNotFoundException struct { @@ -20637,17 +20799,17 @@ func (s *TargetNotFoundException) RequestID() string { type Task struct { _ struct{} `type:"structure"` - // The Elastic Network Adapter associated with the task if the task uses the - // awsvpc network mode. + // The Elastic Network Adapter that's associated with the task if the task uses + // the awsvpc network mode. Attachments []*Attachment `locationName:"attachments" type:"list"` // The attributes of the task Attributes []*Attribute `locationName:"attributes" type:"list"` - // The availability zone of the task. + // The Availability Zone for the task. AvailabilityZone *string `locationName:"availabilityZone" type:"string"` - // The capacity provider associated with the task. + // The capacity provider that's associated with the task. CapacityProviderName *string `locationName:"capacityProviderName" type:"string"` // The ARN of the cluster that hosts the task. @@ -20656,28 +20818,31 @@ type Task struct { // The connectivity status of a task. Connectivity *string `locationName:"connectivity" type:"string" enum:"Connectivity"` - // The Unix timestamp for when the task last went into CONNECTED status. + // The Unix timestamp for the time when the task last went into CONNECTED status. ConnectivityAt *time.Time `locationName:"connectivityAt" type:"timestamp"` // The ARN of the container instances that host the task. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` - // The containers associated with the task. + // The containers that's associated with the task. Containers []*Container `locationName:"containers" type:"list"` // The number of CPU units used by the task as expressed in a task definition. - // It can be expressed as an integer using CPU units, for example 1024. It can - // also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. - // String values are converted to an integer indicating the CPU units when the - // task definition is registered. + // It can be expressed as an integer using CPU units (for example, 1024). It + // can also be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). + // String values are converted to an integer that indicates the CPU units when + // the task definition is registered. // - // If you are using the EC2 launch type, this field is optional. Supported values + // If you use the EC2 launch type, this field is optional. Supported values // are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported + // If you use the Fargate launch type, this field is required. You must use + // one of the following values. These values determine the range of supported // values for the memory parameter: // + // The CPU units cannot be less than 1 vCPU when you use Windows containers + // on Fargate. + // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) // @@ -20694,64 +20859,64 @@ type Task struct { // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` - // The Unix timestamp for when the task was created (the task entered the PENDING - // state). + // The Unix timestamp for the time when the task was created. More specifically, + // it's for the time when the task entered the PENDING state. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The desired status of the task. For more information, see Task Lifecycle // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). DesiredStatus *string `locationName:"desiredStatus" type:"string"` - // Whether or not execute command functionality is enabled for this task. If - // true, this enables execute command functionality on all containers in the - // task. + // Determines whether execute command functionality is enabled for this task. + // If true, execute command functionality is enabled on all the containers in + // the task. EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"` // The ephemeral storage settings for the task. EphemeralStorage *EphemeralStorage `locationName:"ephemeralStorage" type:"structure"` - // The Unix timestamp for when the task execution stopped. + // The Unix timestamp for the time when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp"` - // The name of the task group associated with the task. + // The name of the task group that's associated with the task. Group *string `locationName:"group" type:"string"` - // The health status for the task, which is determined by the health of the - // essential containers in the task. If all essential containers in the task - // are reporting as HEALTHY, then the task status also reports as HEALTHY. If - // any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, - // then the task status also reports as UNHEALTHY or UNKNOWN, accordingly. - // - // The Amazon ECS container agent does not monitor or report on Docker health - // checks that are embedded in a container image (such as those specified in - // a parent image or from the image's Dockerfile) and not specified in the container - // definition. Health check parameters that are specified in a container definition - // override any Docker health checks that exist in the container image. + // The health status for the task. It's determined by the health of the essential + // containers in the task. If all essential containers in the task are reporting + // as HEALTHY, the task status also reports as HEALTHY. If any essential containers + // in the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports + // as UNHEALTHY or UNKNOWN. + // + // The Amazon ECS container agent doesn't monitor or report on Docker health + // checks that are embedded in a container image and not specified in the container + // definition. For example, this includes those specified in a parent image + // or from the image's Dockerfile. Health check parameters that are specified + // in a container definition override any Docker health checks that are found + // in the container image. HealthStatus *string `locationName:"healthStatus" type:"string" enum:"HealthStatus"` - // The Elastic Inference accelerator associated with the task. + // The Elastic Inference accelerator that's associated with the task. InferenceAccelerators []*InferenceAccelerator `locationName:"inferenceAccelerators" type:"list"` - // The last known status of the task. For more information, see Task Lifecycle + // The last known status for the task. For more information, see Task Lifecycle // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). LastStatus *string `locationName:"lastStatus" type:"string"` - // The infrastructure on which your task is running. For more information, see - // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // The infrastructure where your task runs on. For more information, see Amazon + // ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // The amount of memory (in MiB) used by the task as expressed in a task definition. - // It can be expressed as an integer using MiB, for example 1024. It can also - // be expressed as a string using GB, for example 1GB or 1 GB. String values - // are converted to an integer indicating the MiB when the task definition is - // registered. + // The amount of memory (in MiB) that the task uses as expressed in a task definition. + // It can be expressed as an integer using MiB (for example, 1024). If it's + // expressed as a string using GB (for example, 1GB or 1 GB), it's converted + // to an integer indicating the MiB when the task definition is registered. // - // If you are using the EC2 launch type, this field is optional. + // If you use the EC2 launch type, this field is optional. // - // If you are using the Fargate launch type, this field is required and you - // must use one of the following values, which determines your range of supported - // values for the cpu parameter: + // If you use the Fargate launch type, this field is required. You must use + // one of the following values. The value that you choose determines the range + // of supported values for the cpu parameter. // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) @@ -20773,52 +20938,53 @@ type Task struct { Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The operating system that your tasks are running on. A platform family is - // specified only for tasks using the Fargate launch type. + // specified only for tasks that use the Fargate launch type. // // All tasks that run as part of this service must use the same platformFamily - // value as the service, for example, LINUX.. + // value as the service (for example, LINUX.). PlatformFamily *string `locationName:"platformFamily" type:"string"` - // The platform version on which your task is running. A platform version is - // only specified for tasks using the Fargate launch type. If one is not specified, - // the LATEST platform version is used by default. For more information, see - // Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version where your task runs on. A platform version is only + // specified for tasks that use the Fargate launch type. If you didn't specify + // one, the LATEST platform version is used. 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"` - // The Unix timestamp for when the container image pull began. + // The Unix timestamp for the time when the container image pull began. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp"` - // The Unix timestamp for when the container image pull completed. + // The Unix timestamp for the time when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp"` - // The Unix timestamp for when the task started (the task transitioned from - // the PENDING state to the RUNNING state). + // The Unix timestamp for the time when the task started. More specifically, + // it's for the time when the task transitioned from the PENDING state to the + // RUNNING state. StartedAt *time.Time `locationName:"startedAt" type:"timestamp"` - // The tag specified when a task is started. If the task is started by an Amazon - // ECS service, then the startedBy parameter contains the deployment ID of the - // service that starts it. + // The tag specified when a task is started. If an Amazon ECS service started + // the task, the startedBy parameter contains the deployment ID of that service. StartedBy *string `locationName:"startedBy" type:"string"` - // The stop code indicating why a task was stopped. The stoppedReason may contain - // additional details. + // The stop code indicating why a task was stopped. The stoppedReason might + // contain additional details. StopCode *string `locationName:"stopCode" type:"string" enum:"TaskStopCode"` - // The Unix timestamp for when the task was stopped (the task transitioned from - // the RUNNING state to the STOPPED state). + // The Unix timestamp for the time when the task was stopped. More specifically, + // it's for the time when the task transitioned from the RUNNING state to the + // STOPPED state. StoppedAt *time.Time `locationName:"stoppedAt" type:"timestamp"` // The reason that the task was stopped. StoppedReason *string `locationName:"stoppedReason" type:"string"` - // The Unix timestamp for when the task stops (transitions from the RUNNING - // state to STOPPED). + // The Unix timestamp for the time when the task stops. More specifically, it's + // for the time when the task transitions from the RUNNING state to STOPPED. StoppingAt *time.Time `locationName:"stoppingAt" type:"timestamp"` // The metadata that you apply to the task to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. + // the task. Each tag consists of a key and an optional value. You define both + // the key and value. // // The following basic restrictions apply to tags: // @@ -20851,11 +21017,11 @@ type Task struct { TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"` // The version counter for the task. Every time a task experiences a change - // that triggers a CloudWatch event, the version counter is incremented. If - // you are replicating your Amazon ECS task state with CloudWatch Events, you - // can compare the version of a task reported by the Amazon ECS API actions - // with the version reported in CloudWatch Events for the task (inside the detail - // object) to verify that the version in your event stream is current. + // that starts a CloudWatch event, the version counter is incremented. If you + // replicate your Amazon ECS task state with CloudWatch Events, you can compare + // the version of a task reported by the Amazon ECS API actions with the version + // reported in CloudWatch Events for the task (inside the detail object) to + // verify that the version in your event stream is current. Version *int64 `locationName:"version" type:"long"` } @@ -21112,11 +21278,14 @@ type TaskDefinition struct { // in the Amazon Elastic Container Service Developer Guide. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list"` - // The number of cpu units used by the task. If you are using the EC2 launch - // type, this field is optional and any value can be used. If you are using - // the Fargate launch type, this field is required and you must use one of the - // following values, which determines your range of valid values for the memory - // parameter: + // The number of cpu units used by the task. If you use the EC2 launch type, + // this field is optional. Any value can be used. If you use the Fargate launch + // type, this field is required. You must use one of the following values. The + // value that you choose determines your range of valid values for the memory + // parameter. + // + // The CPU units cannot be less than 1 vCPU when you use Windows containers + // on Fargate. // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) @@ -21134,7 +21303,7 @@ type TaskDefinition struct { // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` - // The Unix timestamp for when the task definition was deregistered. + // The Unix timestamp for the time when the task definition was deregistered. DeregisteredAt *time.Time `locationName:"deregisteredAt" type:"timestamp"` // The ephemeral storage settings to use for tasks run with the task definition. @@ -21149,8 +21318,8 @@ type TaskDefinition struct { ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"` // The name of a family that this task definition is registered to. Up to 255 - // letters (uppercase and lowercase), numbers, hyphens, and underscores are - // allowed. + // characters are allowed. Letters (both uppercase and lowercase letters), numbers, + // hyphens (-), and underscores (_) are allowed. // // A family groups multiple versions of a task definition. Amazon ECS gives // the first task definition that you registered to a family a revision number @@ -21158,7 +21327,7 @@ type TaskDefinition struct { // that you add. Family *string `locationName:"family" type:"string"` - // The Elastic Inference accelerator associated with the task. + // The Elastic Inference accelerator that's associated with the task. InferenceAccelerators []*InferenceAccelerator `locationName:"inferenceAccelerators" type:"list"` // The IPC resource namespace to use for the containers in the task. The valid @@ -21193,15 +21362,15 @@ type TaskDefinition struct { // The amount (in MiB) of memory used by the task. // - // If your tasks will be run on Amazon EC2 instances, you must specify either - // a task-level memory value or a container-level memory value. This field is - // optional and any value can be used. If a task-level memory value is specified - // then the container-level memory value is optional. For more information regarding - // container-level memory and memory reservation, see ContainerDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). + // If your tasks runs on Amazon EC2 instances, you must specify either a task-level + // memory value or a container-level memory value. This field is optional and + // any value can be used. If a task-level memory value is specified, the container-level + // memory value is optional. For more information regarding container-level + // memory and memory reservation, see ContainerDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). // - // If your tasks will be run on Fargate, this field is required and you must - // use one of the following values, which determines your range of valid values - // for the cpu parameter: + // If your tasks runs on Fargate, this field is required. You must use one of + // the following values. The value you choose determines your range of valid + // values for the cpu parameter. // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) @@ -21271,7 +21440,7 @@ type TaskDefinition struct { // An array of placement constraint objects to use for tasks. // - // This parameter is not supported for tasks run on Fargate. + // This parameter isn't supported for tasks run on Fargate. PlacementConstraints []*TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The configuration details for the App Mesh proxy. @@ -21279,13 +21448,13 @@ type TaskDefinition struct { // Your Amazon ECS container instances require at least version 1.26.0 of the // container agent and at least version 1.26.0-1 of the ecs-init package to // enable a proxy configuration. If your container instances are launched from - // the Amazon ECS-optimized AMI version 20190301 or later, then they contain - // the required versions of the container agent and ecs-init. For more information, + // the Amazon ECS optimized AMI version 20190301 or later, they contain the + // required versions of the container agent and ecs-init. For more information, // see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"` - // The Unix timestamp for when the task definition was registered. + // The Unix timestamp for the time when the task definition was registered. RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp"` // The principal that registered the task definition. @@ -21293,13 +21462,14 @@ type TaskDefinition struct { // The container instance attributes required by your task. When an Amazon EC2 // instance is registered to your cluster, the Amazon ECS container agent assigns - // some standard attributes to the instance. You can apply custom attributes, - // specified as key-value pairs using the Amazon ECS console or the PutAttributes - // API. These attributes are used when considering task placement for tasks - // hosted on Amazon EC2 instances. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) + // some standard attributes to the instance. You can apply custom attributes. + // These are specified as key-value pairs using the Amazon ECS console or the + // PutAttributes API. These attributes are used when determining task placement + // for tasks hosted on Amazon EC2 instances. For more information, see Attributes + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. // - // This parameter is not supported for tasks run on Fargate. + // This parameter isn't supported for tasks run on Fargate. RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"` // The task launch types the task definition was validated against. To determine @@ -21311,8 +21481,8 @@ type TaskDefinition struct { // number of a task definition in a family. When you register a task definition // for the first time, the revision is 1. Each time that you register a new // revision of a task definition in the same family, the revision value always - // increases by one, even if you have deregistered previous revisions in this - // family. + // increases by one. This is even if you deregistered previous revisions in + // this family. Revision *int64 `locationName:"revision" type:"integer"` // The operating system that your task definitions are running on. A platform @@ -21336,8 +21506,8 @@ type TaskDefinition struct { // // IAM roles for tasks on Windows require that the -EnableTaskIAMRole option // is set when you launch the Amazon ECS-optimized Windows AMI. Your containers - // must also run some configuration code in order to take advantage of the feature. - // For more information, see Windows IAM roles for tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) + // must also run some configuration code to use the feature. For more information, + // see Windows IAM roles for tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string `locationName:"taskRoleArn" type:"string"` @@ -21345,7 +21515,7 @@ type TaskDefinition struct { // Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) // in the Amazon Elastic Container Service Developer Guide. // - // The host and sourcePath parameters are not supported for tasks run on Fargate. + // The host and sourcePath parameters aren't supported for tasks run on Fargate. Volumes []*Volume `locationName:"volumes" type:"list"` } @@ -21515,7 +21685,7 @@ func (s *TaskDefinition) SetVolumes(v []*Volume) *TaskDefinition { // For more information, see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. // -// Task placement constraints are not supported for tasks run on Fargate. +// Task placement constraints aren't supported for tasks run on Fargate. type TaskDefinitionPlacementConstraint struct { _ struct{} `type:"structure"` @@ -21559,11 +21729,11 @@ func (s *TaskDefinitionPlacementConstraint) SetType(v string) *TaskDefinitionPla return s } -// The overrides associated with a task. +// The overrides that are associated with a task. type TaskOverride struct { _ struct{} `type:"structure"` - // One or more container overrides sent to a task. + // One or more container overrides that are sent to a task. ContainerOverrides []*ContainerOverride `locationName:"containerOverrides" type:"list"` // The cpu override for the task. @@ -21571,8 +21741,8 @@ type TaskOverride struct { // The ephemeral storage setting override for the task. // - // This parameter is only supported for tasks hosted on Fargate using the following - // platform versions: + // This parameter is only supported for tasks hosted on Fargate that use the + // following platform versions: // // * Linux platform version 1.4.0 or later. // @@ -21690,7 +21860,7 @@ func (s *TaskOverride) SetTaskRoleArn(v string) *TaskOverride { type TaskSet struct { _ struct{} `type:"structure"` - // The capacity provider strategy associated with the task set. + // The capacity provider strategy that are associated with the task set. CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` // The Amazon Resource Name (ARN) of the cluster that the service that hosts @@ -21703,12 +21873,12 @@ type TaskSet struct { // it rounds up to 2 tasks. ComputedDesiredCount *int64 `locationName:"computedDesiredCount" type:"integer"` - // The Unix timestamp for when the task set was created. + // The Unix timestamp for the time when the task set was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` // The external ID associated with the task set. // - // If a task set is created by an CodeDeploy deployment, the externalId parameter + // If an CodeDeploy deployment created a task set, the externalId parameter // contains the CodeDeploy deployment ID. // // If a task set is created for an external deployment and is associated with @@ -21724,7 +21894,7 @@ type TaskSet struct { // in the Amazon Elastic Container Service Developer Guide. LaunchType *string `locationName:"launchType" type:"string" enum:"LaunchType"` - // Details on a load balancer that is used with a task set. + // Details on a load balancer that are used with a task set. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The network configuration for the task set. @@ -21733,16 +21903,16 @@ type TaskSet struct { // The number of tasks in the task set that are in the PENDING status during // a deployment. A task in the PENDING state is preparing to enter the RUNNING // state. A task set enters the PENDING status when it launches for the first - // time or when it is restarted after being in the STOPPED state. + // time or when it's restarted after being in the STOPPED state. PendingCount *int64 `locationName:"pendingCount" type:"integer"` // The operating system that your tasks in the set are running on. A platform - // family is specified only for tasks using the Fargate launch type. + // family is specified only for tasks that use the Fargate launch type. // // All tasks in the set must have the same value. PlatformFamily *string `locationName:"platformFamily" type:"string"` - // The Fargate platform version on which the tasks in the task set are running. + // The Fargate platform version where the tasks in the task set are running. // A platform version is only specified for tasks run on Fargate. 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. @@ -21752,43 +21922,42 @@ type TaskSet struct { // a deployment. A task in the RUNNING state is running and ready for use. RunningCount *int64 `locationName:"runningCount" type:"integer"` - // A floating-point percentage of the desired number of tasks to place and keep - // running in the task set. + // A floating-point percentage of your desired number of tasks to place and + // keep running in the task set. Scale *Scale `locationName:"scale" type:"structure"` // The Amazon Resource Name (ARN) of the service the task set exists in. ServiceArn *string `locationName:"serviceArn" type:"string"` - // The details of the service discovery registries to assign to this task set. + // The details for the service discovery registries to assign to this task set. // For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" type:"list"` - // The stability status, which indicates whether the task set has reached a - // steady state. If the following conditions are met, the task set will be in - // STEADY_STATE: + // The stability status. This indicates whether the task set has reached a steady + // state. If the following conditions are met, the task set sre in STEADY_STATE: // // * The task runningCount is equal to the computedDesiredCount. // // * The pendingCount is 0. // - // * There are no tasks running on container instances in the DRAINING status. + // * There are no tasks that are running on container instances in the DRAINING + // status. // // * All tasks are reporting a healthy status from the load balancers, service // discovery, and container health checks. // - // If any of those conditions are not met, the stability status returns STABILIZING. + // If any of those conditions aren't met, the stability status returns STABILIZING. StabilityStatus *string `locationName:"stabilityStatus" type:"string" enum:"StabilityStatus"` - // The Unix timestamp for when the task set stability status was retrieved. + // The Unix timestamp for the time when the task set stability status was retrieved. StabilityStatusAt *time.Time `locationName:"stabilityStatusAt" type:"timestamp"` - // The tag specified when a task set is started. If the task set is created - // by an CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For - // a task set created for an external deployment, the startedBy field isn't - // used. + // The tag specified when a task set is started. If an CodeDeploy deployment + // created the task set, the startedBy parameter is CODE_DEPLOY. If an external + // deployment created the task set, the startedBy field isn't used. StartedBy *string `locationName:"startedBy" type:"string"` - // The status of the task set. The following describes each state: + // The status of the task set. The following describes each state. // // PRIMARY // @@ -21796,17 +21965,16 @@ type TaskSet struct { // // ACTIVE // - // The task set is not serving production traffic. + // The task set isn't serving production traffic. // // DRAINING // - // The tasks in the task set are being stopped and their corresponding targets + // The tasks in the task set are being stopped, and their corresponding targets // are being deregistered from their target group. Status *string `locationName:"status" type:"string"` // The metadata that you apply to the task set to help you categorize and organize - // them. Each tag consists of a key and an optional value, both of which you - // define. + // them. Each tag consists of a key and an optional value. You define both. // // The following basic restrictions apply to tags: // @@ -21832,13 +22000,13 @@ type TaskSet struct { // Tags with this prefix do not count against your tags per resource limit. Tags []*Tag `locationName:"tags" type:"list"` - // The task definition the task set is using. + // The task definition that the task set is using. TaskDefinition *string `locationName:"taskDefinition" type:"string"` // The Amazon Resource Name (ARN) of the task set. TaskSetArn *string `locationName:"taskSetArn" type:"string"` - // The Unix timestamp for when the task set was last updated. + // The Unix timestamp for the time when the task set was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -22004,9 +22172,9 @@ func (s *TaskSet) SetUpdatedAt(v time.Time) *TaskSet { return s } -// The specified task set could not be found. You can view your available task -// sets with DescribeTaskSets. Task sets are specific to each cluster, service -// and Region. +// The specified task set wasn't found. You can view your available task sets +// with DescribeTaskSets. Task sets are specific to each cluster, service and +// Region. type TaskSetNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -22228,7 +22396,7 @@ func (s *Ulimit) SetSoftLimit(v int64) *Ulimit { return s } -// The specified task is not supported in this Region. +// The specified task isn't supported in this Region. type UnsupportedFeatureException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -22295,9 +22463,9 @@ func (s *UnsupportedFeatureException) RequestID() string { type UntagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the resource from which to delete tags. - // Currently, the supported resources are Amazon ECS capacity providers, tasks, - // services, task definitions, clusters, and container instances. + // The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, + // the supported resources are Amazon ECS capacity providers, tasks, services, + // task definitions, clusters, and container instances. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` @@ -22379,7 +22547,7 @@ func (s UntagResourceOutput) GoString() string { type UpdateCapacityProviderInput struct { _ struct{} `type:"structure"` - // An object representing the parameters to update for the Auto Scaling group + // An object that represent the parameters to update for the Auto Scaling group // capacity provider. // // AutoScalingGroupProvider is a required field @@ -22578,8 +22746,7 @@ type UpdateClusterSettingsInput struct { // The setting to use by default for a cluster. This parameter is used to enable // CloudWatch Container Insights for a cluster. If this value is specified, - // it will override the containerInsights value set with PutAccountSetting or - // PutAccountSettingDefault. + // it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. // // Settings is a required field Settings []*ClusterSetting `locationName:"settings" type:"list" required:"true"` @@ -22671,7 +22838,7 @@ type UpdateContainerAgentInput struct { Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full ARN entries for the container instance - // on which you would like to update the Amazon ECS container agent. + // where you would like to update the Amazon ECS container agent. // // ContainerInstance is a required field ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` @@ -22723,7 +22890,7 @@ func (s *UpdateContainerAgentInput) SetContainerInstance(v string) *UpdateContai type UpdateContainerAgentOutput struct { _ struct{} `type:"structure"` - // The container instance for which the container agent was updated. + // The container instance that the container agent was updated for. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` } @@ -22764,12 +22931,12 @@ type UpdateContainerInstancesStateInput struct { // ContainerInstances is a required field ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` - // The container instance state with which to update the container instance. - // The only valid values for this action are ACTIVE and DRAINING. A container - // instance can only be updated to DRAINING status once it has reached an ACTIVE - // state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED - // state you can describe the container instance but will be unable to update - // the container instance state. + // The container instance state to update the container instance with. The only + // valid values for this action are ACTIVE and DRAINING. A container instance + // can only be updated to DRAINING status once it has reached an ACTIVE state. + // If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED + // state you can describe the container instance but can't update the container + // instance state. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"ContainerInstanceStatus"` @@ -22867,9 +23034,9 @@ func (s *UpdateContainerInstancesStateOutput) SetFailures(v []*Failure) *UpdateC return s } -// There is already a current Amazon ECS container agent update in progress -// on the specified container instance. If the container agent becomes disconnected -// while it is in a transitional stage, such as PENDING or STAGING, the update +// There's already a current Amazon ECS container agent update in progress on +// the container instance that's specified. If the container agent becomes disconnected +// while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. type UpdateInProgressException struct { @@ -22940,11 +23107,11 @@ type UpdateServiceInput struct { // The capacity provider strategy to update the service to use. // - // If the service is using the default capacity provider strategy for the cluster, + // if the service uses the default capacity provider strategy for the cluster, // the service can be updated to use one or more capacity providers as opposed // to the default capacity provider strategy. However, when a service is using - // a capacity provider strategy that is not the default capacity provider strategy, - // the service cannot be updated to use the cluster's default capacity provider + // a capacity provider strategy that's not the default capacity provider strategy, + // the service can't be updated to use the cluster's default capacity provider // strategy. // // A capacity provider strategy consists of one or more capacity providers along @@ -22966,8 +23133,8 @@ type UpdateServiceInput struct { CapacityProviderStrategy []*CapacityProviderStrategyItem `locationName:"capacityProviderStrategy" type:"list"` // The short name or full Amazon Resource Name (ARN) of the cluster that your - // service is running on. If you do not specify a cluster, the default cluster - // is assumed. + // service runs on. If you do not specify a cluster, the default cluster is + // assumed. Cluster *string `locationName:"cluster" type:"string"` // Optional deployment parameters that control how many tasks run during the @@ -22984,22 +23151,22 @@ type UpdateServiceInput struct { // created, you can set this to null when performing this action. EnableExecuteCommand *bool `locationName:"enableExecuteCommand" type:"boolean"` - // Whether to force a new deployment of the service. Deployments are not forced - // by default. You can use this option to trigger a new deployment with no service - // definition changes. For example, you can update a service's tasks to use - // a newer Docker image with the same image/tag combination (my_image:latest) + // Determines whether to force a new deployment of the service. By default, + // deployments aren't forced. You can use this option to start a new deployment + // with no service definition changes. For example, you can update a service's + // tasks to use a newer Docker image with the same image/tag combination (my_image:latest) // or to roll Fargate tasks onto a newer platform version. ForceNewDeployment *bool `locationName:"forceNewDeployment" type:"boolean"` - // The period of time, in seconds, that the Amazon ECS service scheduler should - // ignore unhealthy Elastic Load Balancing target health checks after a task - // has first started. This is only valid if your service is configured to use - // a load balancer. If your service's tasks take a while to start and respond - // to Elastic Load Balancing health checks, you can specify a health check grace - // period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service - // scheduler ignores the Elastic Load Balancing health check status. This grace - // period can prevent the ECS service scheduler from marking tasks as unhealthy - // and stopping them before they have time to come up. + // The period of time, in seconds, that the Amazon ECS service scheduler ignores + // unhealthy Elastic Load Balancing target health checks after a task has first + // started. This is only valid if your service is configured to use a load balancer. + // If your service's tasks take a while to start and respond to Elastic Load + // Balancing health checks, you can specify a health check grace period of up + // to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler + // ignores the Elastic Load Balancing health check status. This grace period + // can prevent the ECS service scheduler from marking tasks as unhealthy and + // stopping them before they have time to come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` // An object representing the network configuration for the service. @@ -23011,8 +23178,8 @@ type UpdateServiceInput struct { // placement constraints defined for the service. To remove all existing placement // constraints, specify an empty array. // - // You can specify a maximum of 10 constraints per task (this limit includes - // constraints in the task definition and those specified at runtime). + // You can specify a maximum of 10 constraints for each task. This limit includes + // constraints in the task definition and those specified at runtime. PlacementConstraints []*PlacementConstraint `locationName:"placementConstraints" type:"list"` // The task placement strategy objects to update the service to use. If no value @@ -23021,13 +23188,13 @@ type UpdateServiceInput struct { // strategy defined for the service. To remove an existing placement strategy, // specify an empty object. // - // You can specify a maximum of five strategy rules per service. + // You can specify a maximum of five strategy rules for each service. PlacementStrategy []*PlacementStrategy `locationName:"placementStrategy" type:"list"` - // The platform version on which your tasks in the service are running. A platform - // version is only specified for tasks using the Fargate launch type. If a platform - // version is not specified, the LATEST platform version is used by default. - // For more information, see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // The platform version that your tasks in the service run on. A platform version + // is only specified for tasks using the Fargate launch type. If a platform + // version is not specified, the LATEST platform version is used. 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"` @@ -23316,7 +23483,7 @@ type UpdateTaskSetInput struct { _ struct{} `type:"structure"` // The short name or full Amazon Resource Name (ARN) of the cluster that hosts - // the service that the task set exists in. + // the service that the task set is found in. // // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` @@ -23328,7 +23495,7 @@ type UpdateTaskSetInput struct { Scale *Scale `locationName:"scale" type:"structure" required:"true"` // The short name or full Amazon Resource Name (ARN) of the service that the - // task set exists in. + // task set is found in. // // Service is a required field Service *string `locationName:"service" type:"string" required:"true"` @@ -23446,7 +23613,7 @@ type VersionInfo struct { // The version number of the Amazon ECS container agent. AgentVersion *string `locationName:"agentVersion" type:"string"` - // The Docker version running on the container instance. + // The Docker version that's running on the container instance. DockerVersion *string `locationName:"dockerVersion" type:"string"` } @@ -23486,42 +23653,42 @@ func (s *VersionInfo) SetDockerVersion(v string) *VersionInfo { return s } -// A data volume used in a task definition. For tasks that use the Amazon Elastic -// File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows -// tasks that use Amazon FSx for Windows File Server file system, specify a -// fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, +// A data volume that's used in a task definition. For tasks that use the Amazon +// Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For +// Windows tasks that use Amazon FSx for Windows File Server file system, specify +// a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, // specify a DockerVolumeConfiguration. For tasks that use a bind mount host // volume, specify a host and optional sourcePath. For more information, see // Using Data Volumes in Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). type Volume struct { _ struct{} `type:"structure"` - // This parameter is specified when you are using Docker volumes. + // This parameter is specified when you use Docker volumes. // // Windows containers only support the use of the local driver. To use bind // mounts, specify the host parameter instead. // - // Docker volumes are not supported by tasks run on Fargate. + // Docker volumes aren't supported by tasks run on Fargate. DockerVolumeConfiguration *DockerVolumeConfiguration `locationName:"dockerVolumeConfiguration" type:"structure"` - // This parameter is specified when you are using an Amazon Elastic File System - // file system for task storage. + // This parameter is specified when you use an Amazon Elastic File System file + // system for task storage. EfsVolumeConfiguration *EFSVolumeConfiguration `locationName:"efsVolumeConfiguration" type:"structure"` - // This parameter is specified when you are using Amazon FSx for Windows File - // Server file system for task storage. + // This parameter is specified when you use Amazon FSx for Windows File Server + // file system for task storage. FsxWindowsFileServerVolumeConfiguration *FSxWindowsFileServerVolumeConfiguration `locationName:"fsxWindowsFileServerVolumeConfiguration" type:"structure"` - // This parameter is specified when you are using bind mount host volumes. The - // contents of the host parameter determine whether your bind mount host 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 is not guaranteed to persist after the containers + // This parameter is specified when you use bind mount host volumes. The contents + // of the host parameter determine whether your bind mount host volume persists + // on the host container instance and where it's 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 that are // associated with it stop running. // // Windows containers can mount whole directories on the same drive as $env:ProgramData. - // Windows containers cannot mount directories on a different drive, and mount - // point cannot be across drives. For example, you can mount C:\my\path:C:\my\path + // Windows containers can't mount directories on a different drive, and mount + // point can't be across drives. For example, you can mount C:\my\path:C:\my\path // and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path. Host *HostVolumeProperties `locationName:"host" type:"structure"` @@ -23608,8 +23775,8 @@ type VolumeFrom struct { // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` - // The name of another container within the same task definition from which - // to mount volumes. + // The name of another container within the same task definition to mount volumes + // from. SourceContainer *string `locationName:"sourceContainer" type:"string"` } @@ -23870,12 +24037,16 @@ func ContainerCondition_Values() []string { const ( // ContainerInstanceFieldTags is a ContainerInstanceField enum value ContainerInstanceFieldTags = "TAGS" + + // ContainerInstanceFieldContainerInstanceHealth is a ContainerInstanceField enum value + ContainerInstanceFieldContainerInstanceHealth = "CONTAINER_INSTANCE_HEALTH" ) // ContainerInstanceField_Values returns all elements of the ContainerInstanceField enum func ContainerInstanceField_Values() []string { return []string{ ContainerInstanceFieldTags, + ContainerInstanceFieldContainerInstanceHealth, } } @@ -24087,6 +24258,42 @@ func HealthStatus_Values() []string { } } +const ( + // InstanceHealthCheckStateOk is a InstanceHealthCheckState enum value + InstanceHealthCheckStateOk = "OK" + + // InstanceHealthCheckStateImpaired is a InstanceHealthCheckState enum value + InstanceHealthCheckStateImpaired = "IMPAIRED" + + // InstanceHealthCheckStateInsufficientData is a InstanceHealthCheckState enum value + InstanceHealthCheckStateInsufficientData = "INSUFFICIENT_DATA" + + // InstanceHealthCheckStateInitializing is a InstanceHealthCheckState enum value + InstanceHealthCheckStateInitializing = "INITIALIZING" +) + +// InstanceHealthCheckState_Values returns all elements of the InstanceHealthCheckState enum +func InstanceHealthCheckState_Values() []string { + return []string{ + InstanceHealthCheckStateOk, + InstanceHealthCheckStateImpaired, + InstanceHealthCheckStateInsufficientData, + InstanceHealthCheckStateInitializing, + } +} + +const ( + // InstanceHealthCheckTypeContainerRuntime is a InstanceHealthCheckType enum value + InstanceHealthCheckTypeContainerRuntime = "CONTAINER_RUNTIME" +) + +// InstanceHealthCheckType_Values returns all elements of the InstanceHealthCheckType enum +func InstanceHealthCheckType_Values() []string { + return []string{ + InstanceHealthCheckTypeContainerRuntime, + } +} + const ( // IpcModeHost is a IpcMode enum value IpcModeHost = "host" diff --git a/service/ecs/doc.go b/service/ecs/doc.go index 0412756ee2c..6c10c55e768 100644 --- a/service/ecs/doc.go +++ b/service/ecs/doc.go @@ -4,21 +4,22 @@ // requests to Amazon EC2 Container Service. // // Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, -// container management service that makes it easy to run, stop, and manage -// Docker containers on a cluster. You can host your cluster on a serverless -// infrastructure that is managed by Amazon ECS by launching your services or -// tasks on Fargate. For more control, you can host your tasks on a cluster -// of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage. +// container management service. It makes it easy to run, stop, and manage Docker +// containers on a cluster. You can host your cluster on a serverless infrastructure +// that's managed by Amazon ECS by launching your services or tasks on Fargate. +// For more control, you can host your tasks on a cluster of Amazon Elastic +// Compute Cloud (Amazon EC2) instances that you manage. // // Amazon ECS makes it easy to launch and stop container-based applications -// with simple API calls, allows you to get the state of your cluster from a -// centralized service, and gives you access to many familiar Amazon EC2 features. +// with simple API calls. This makes it easy to get the state of your cluster +// from a centralized service, and gives you access to many familiar Amazon +// EC2 features. // // You can use Amazon ECS to schedule the placement of containers across your // cluster based on your resource needs, isolation policies, and availability -// requirements. Amazon ECS eliminates the need for you to operate your own -// cluster management and configuration management systems or worry about scaling -// your management infrastructure. +// requirements. With Amazon ECS, you don't need to operate your own cluster +// management and configuration management systems. You also don't need to worry +// about scaling your management infrastructure. // // See https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13 for more information on this service. // diff --git a/service/ecs/errors.go b/service/ecs/errors.go index aca576fb139..b9558d6e4a1 100644 --- a/service/ecs/errors.go +++ b/service/ecs/errors.go @@ -11,36 +11,37 @@ const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // - // You do not have authorization to perform the requested action. + // You don't have authorization to perform the requested action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeAttributeLimitExceededException for service response error code // "AttributeLimitExceededException". // - // You can apply up to 10 custom attributes per resource. You can view the attributes - // of a resource with ListAttributes. You can remove existing attributes on - // a resource with DeleteAttributes. + // You can apply up to 10 custom attributes for each resource. You can view + // the attributes of a resource with ListAttributes. You can remove existing + // attributes on a resource with DeleteAttributes. ErrCodeAttributeLimitExceededException = "AttributeLimitExceededException" // ErrCodeBlockedException for service response error code // "BlockedException". // - // Your Amazon Web Services account has been blocked. For more information, - // contact Amazon Web Services Support (http://aws.amazon.com/contact-us/). + // Your Amazon Web Services account was blocked. For more information, contact + // Amazon Web Services Support (http://aws.amazon.com/contact-us/). ErrCodeBlockedException = "BlockedException" // ErrCodeClientException for service response error code // "ClientException". // - // These errors are usually caused by a client action, such as using an action - // or resource on behalf of a user that doesn't have permissions to use the - // action or resource, or specifying an identifier that is not valid. + // These errors are usually caused by a client action. This client action might + // be using an action or resource on behalf of a user that doesn't have permissions + // to use the action or resource,. Or, it might be specifying an identifier + // that isn't valid. ErrCodeClientException = "ClientException" // ErrCodeClusterContainsContainerInstancesException for service response error code // "ClusterContainsContainerInstancesException". // - // You cannot delete a cluster that has registered container instances. First, + // You can't delete a cluster that has registered container instances. First, // deregister the container instances before you can delete the cluster. For // more information, see DeregisterContainerInstance. ErrCodeClusterContainsContainerInstancesException = "ClusterContainsContainerInstancesException" @@ -48,77 +49,77 @@ const ( // ErrCodeClusterContainsServicesException for service response error code // "ClusterContainsServicesException". // - // You cannot delete a cluster that contains services. First, update the service - // to reduce its desired task count to 0 and then delete the service. For more + // You can't delete a cluster that contains services. First, update the service + // to reduce its desired task count to 0, and then delete the service. For more // information, see UpdateService and DeleteService. ErrCodeClusterContainsServicesException = "ClusterContainsServicesException" // ErrCodeClusterContainsTasksException for service response error code // "ClusterContainsTasksException". // - // You cannot delete a cluster that has active tasks. + // You can't delete a cluster that has active tasks. ErrCodeClusterContainsTasksException = "ClusterContainsTasksException" // ErrCodeClusterNotFoundException for service response error code // "ClusterNotFoundException". // - // The specified cluster could not be found. You can view your available clusters - // with ListClusters. Amazon ECS clusters are Region-specific. + // The specified cluster wasn't found. You can view your available clusters + // with ListClusters. Amazon ECS clusters are Region specific. ErrCodeClusterNotFoundException = "ClusterNotFoundException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // - // The specified parameter is invalid. Review the available parameters for the - // API request. + // The specified parameter isn't valid. Review the available parameters for + // the API request. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // - // The limit for the resource has been exceeded. + // The limit for the resource was exceeded. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeMissingVersionException for service response error code // "MissingVersionException". // - // Amazon ECS is unable to determine the current version of the Amazon ECS container - // agent on the container instance and does not have enough information to proceed + // Amazon ECS can't determine the current version of the Amazon ECS container + // agent on the container instance and doesn't have enough information to proceed // with an update. This could be because the agent running on the container - // instance is an older or custom version that does not use our version information. + // instance is a previous or custom version that doesn't use our version information. ErrCodeMissingVersionException = "MissingVersionException" // ErrCodeNoUpdateAvailableException for service response error code // "NoUpdateAvailableException". // - // There is no update available for this Amazon ECS container agent. This could - // be because the agent is already running the latest version, or it is so old - // that there is no update path to the current version. + // There's no update available for this Amazon ECS container agent. This might + // be because the agent is already running the latest version or because it's + // so old that there's no update path to the current version. ErrCodeNoUpdateAvailableException = "NoUpdateAvailableException" // ErrCodePlatformTaskDefinitionIncompatibilityException for service response error code // "PlatformTaskDefinitionIncompatibilityException". // - // The specified platform version does not satisfy the task definition's required - // capabilities. + // The specified platform version doesn't satisfy the required capabilities + // of the task definition. ErrCodePlatformTaskDefinitionIncompatibilityException = "PlatformTaskDefinitionIncompatibilityException" // ErrCodePlatformUnknownException for service response error code // "PlatformUnknownException". // - // The specified platform version does not exist. + // The specified platform version doesn't exist. ErrCodePlatformUnknownException = "PlatformUnknownException" // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". // - // The specified resource is in-use and cannot be removed. + // The specified resource is in-use and can't be removed. ErrCodeResourceInUseException = "ResourceInUseException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // - // The specified resource could not be found. + // The specified resource wasn't found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServerException for service response error code @@ -130,28 +131,28 @@ const ( // ErrCodeServiceNotActiveException for service response error code // "ServiceNotActiveException". // - // The specified service is not active. You can't update a service that is inactive. + // The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with CreateService. ErrCodeServiceNotActiveException = "ServiceNotActiveException" // ErrCodeServiceNotFoundException for service response error code // "ServiceNotFoundException". // - // The specified service could not be found. You can view your available services - // with ListServices. Amazon ECS services are cluster-specific and Region-specific. + // The specified service wasn't found. You can view your available services + // with ListServices. Amazon ECS services are cluster specific and Region specific. ErrCodeServiceNotFoundException = "ServiceNotFoundException" // ErrCodeTargetNotConnectedException for service response error code // "TargetNotConnectedException". // - // The target container is not properly configured with the execute command - // agent or the container is no longer active or running. + // The target container isn't properly configured with the execute command agent + // or the container is no longer active or running. ErrCodeTargetNotConnectedException = "TargetNotConnectedException" // ErrCodeTargetNotFoundException for service response error code // "TargetNotFoundException". // - // The specified target could not be found. You can view your available container + // The specified target wasn't found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are // cluster-specific and Region-specific. ErrCodeTargetNotFoundException = "TargetNotFoundException" @@ -159,23 +160,23 @@ const ( // ErrCodeTaskSetNotFoundException for service response error code // "TaskSetNotFoundException". // - // The specified task set could not be found. You can view your available task - // sets with DescribeTaskSets. Task sets are specific to each cluster, service - // and Region. + // The specified task set wasn't found. You can view your available task sets + // with DescribeTaskSets. Task sets are specific to each cluster, service and + // Region. ErrCodeTaskSetNotFoundException = "TaskSetNotFoundException" // ErrCodeUnsupportedFeatureException for service response error code // "UnsupportedFeatureException". // - // The specified task is not supported in this Region. + // The specified task isn't supported in this Region. ErrCodeUnsupportedFeatureException = "UnsupportedFeatureException" // ErrCodeUpdateInProgressException for service response error code // "UpdateInProgressException". // - // There is already a current Amazon ECS container agent update in progress - // on the specified container instance. If the container agent becomes disconnected - // while it is in a transitional stage, such as PENDING or STAGING, the update + // There's already a current Amazon ECS container agent update in progress on + // the container instance that's specified. If the container agent becomes disconnected + // while it's in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. ErrCodeUpdateInProgressException = "UpdateInProgressException" diff --git a/service/resiliencehub/api.go b/service/resiliencehub/api.go new file mode 100644 index 00000000000..8631cd20207 --- /dev/null +++ b/service/resiliencehub/api.go @@ -0,0 +1,12700 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package resiliencehub + +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 opAddDraftAppVersionResourceMappings = "AddDraftAppVersionResourceMappings" + +// AddDraftAppVersionResourceMappingsRequest generates a "aws/request.Request" representing the +// client's request for the AddDraftAppVersionResourceMappings 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 AddDraftAppVersionResourceMappings for more information on using the AddDraftAppVersionResourceMappings +// 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 AddDraftAppVersionResourceMappingsRequest method. +// req, resp := client.AddDraftAppVersionResourceMappingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/AddDraftAppVersionResourceMappings +func (c *ResilienceHub) AddDraftAppVersionResourceMappingsRequest(input *AddDraftAppVersionResourceMappingsInput) (req *request.Request, output *AddDraftAppVersionResourceMappingsOutput) { + op := &request.Operation{ + Name: opAddDraftAppVersionResourceMappings, + HTTPMethod: "POST", + HTTPPath: "/add-draft-app-version-resource-mappings", + } + + if input == nil { + input = &AddDraftAppVersionResourceMappingsInput{} + } + + output = &AddDraftAppVersionResourceMappingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// AddDraftAppVersionResourceMappings API operation for AWS Resilience Hub. +// +// Adds the resource mapping for the draft application version. +// +// 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 Resilience Hub's +// API operation AddDraftAppVersionResourceMappings for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/AddDraftAppVersionResourceMappings +func (c *ResilienceHub) AddDraftAppVersionResourceMappings(input *AddDraftAppVersionResourceMappingsInput) (*AddDraftAppVersionResourceMappingsOutput, error) { + req, out := c.AddDraftAppVersionResourceMappingsRequest(input) + return out, req.Send() +} + +// AddDraftAppVersionResourceMappingsWithContext is the same as AddDraftAppVersionResourceMappings with the addition of +// the ability to pass a context and additional request options. +// +// See AddDraftAppVersionResourceMappings 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 *ResilienceHub) AddDraftAppVersionResourceMappingsWithContext(ctx aws.Context, input *AddDraftAppVersionResourceMappingsInput, opts ...request.Option) (*AddDraftAppVersionResourceMappingsOutput, error) { + req, out := c.AddDraftAppVersionResourceMappingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateApp = "CreateApp" + +// CreateAppRequest generates a "aws/request.Request" representing the +// client's request for the CreateApp 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 CreateApp for more information on using the CreateApp +// 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 CreateAppRequest method. +// req, resp := client.CreateAppRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateApp +func (c *ResilienceHub) CreateAppRequest(input *CreateAppInput) (req *request.Request, output *CreateAppOutput) { + op := &request.Operation{ + Name: opCreateApp, + HTTPMethod: "POST", + HTTPPath: "/create-app", + } + + if input == nil { + input = &CreateAppInput{} + } + + output = &CreateAppOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateApp API operation for AWS Resilience Hub. +// +// Creates a Resilience Hub application. A Resilience Hub application is a collection +// of Amazon Web Services resources structured to prevent and recover Amazon +// Web Services application disruptions. To describe a Resilience Hub application, +// you provide an application name, resources from one or more–up to five–CloudFormation +// stacks, and an appropriate resiliency policy. +// +//After you create a Resilience Hub application, you publish it so that +// you can run a resiliency assessment on it. You can then use recommendations +// from the assessment to improve resiliency by running another assessment, +// comparing results, and then iterating the process until you achieve your +// goals for recovery time objective (RTO) and recovery point objective (RPO).
+// +// 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 Resilience Hub's +// API operation CreateApp for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ServiceQuotaExceededException +// You have exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use Service Quotas to request a service +// quota increase. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateApp +func (c *ResilienceHub) CreateApp(input *CreateAppInput) (*CreateAppOutput, error) { + req, out := c.CreateAppRequest(input) + return out, req.Send() +} + +// CreateAppWithContext is the same as CreateApp with the addition of +// the ability to pass a context and additional request options. +// +// See CreateApp 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 *ResilienceHub) CreateAppWithContext(ctx aws.Context, input *CreateAppInput, opts ...request.Option) (*CreateAppOutput, error) { + req, out := c.CreateAppRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateRecommendationTemplate = "CreateRecommendationTemplate" + +// CreateRecommendationTemplateRequest generates a "aws/request.Request" representing the +// client's request for the CreateRecommendationTemplate 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 CreateRecommendationTemplate for more information on using the CreateRecommendationTemplate +// 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 CreateRecommendationTemplateRequest method. +// req, resp := client.CreateRecommendationTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateRecommendationTemplate +func (c *ResilienceHub) CreateRecommendationTemplateRequest(input *CreateRecommendationTemplateInput) (req *request.Request, output *CreateRecommendationTemplateOutput) { + op := &request.Operation{ + Name: opCreateRecommendationTemplate, + HTTPMethod: "POST", + HTTPPath: "/create-recommendation-template", + } + + if input == nil { + input = &CreateRecommendationTemplateInput{} + } + + output = &CreateRecommendationTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateRecommendationTemplate API operation for AWS Resilience Hub. +// +// Creates a new recommendation template. +// +// 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 Resilience Hub's +// API operation CreateRecommendationTemplate for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateRecommendationTemplate +func (c *ResilienceHub) CreateRecommendationTemplate(input *CreateRecommendationTemplateInput) (*CreateRecommendationTemplateOutput, error) { + req, out := c.CreateRecommendationTemplateRequest(input) + return out, req.Send() +} + +// CreateRecommendationTemplateWithContext is the same as CreateRecommendationTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See CreateRecommendationTemplate 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 *ResilienceHub) CreateRecommendationTemplateWithContext(ctx aws.Context, input *CreateRecommendationTemplateInput, opts ...request.Option) (*CreateRecommendationTemplateOutput, error) { + req, out := c.CreateRecommendationTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateResiliencyPolicy = "CreateResiliencyPolicy" + +// CreateResiliencyPolicyRequest generates a "aws/request.Request" representing the +// client's request for the CreateResiliencyPolicy 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 CreateResiliencyPolicy for more information on using the CreateResiliencyPolicy +// 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 CreateResiliencyPolicyRequest method. +// req, resp := client.CreateResiliencyPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateResiliencyPolicy +func (c *ResilienceHub) CreateResiliencyPolicyRequest(input *CreateResiliencyPolicyInput) (req *request.Request, output *CreateResiliencyPolicyOutput) { + op := &request.Operation{ + Name: opCreateResiliencyPolicy, + HTTPMethod: "POST", + HTTPPath: "/create-resiliency-policy", + } + + if input == nil { + input = &CreateResiliencyPolicyInput{} + } + + output = &CreateResiliencyPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateResiliencyPolicy API operation for AWS Resilience Hub. +// +// Creates a resiliency policy for an application. +// +// 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 Resilience Hub's +// API operation CreateResiliencyPolicy for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ServiceQuotaExceededException +// You have exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use Service Quotas to request a service +// quota increase. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/CreateResiliencyPolicy +func (c *ResilienceHub) CreateResiliencyPolicy(input *CreateResiliencyPolicyInput) (*CreateResiliencyPolicyOutput, error) { + req, out := c.CreateResiliencyPolicyRequest(input) + return out, req.Send() +} + +// CreateResiliencyPolicyWithContext is the same as CreateResiliencyPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See CreateResiliencyPolicy 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 *ResilienceHub) CreateResiliencyPolicyWithContext(ctx aws.Context, input *CreateResiliencyPolicyInput, opts ...request.Option) (*CreateResiliencyPolicyOutput, error) { + req, out := c.CreateResiliencyPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteApp = "DeleteApp" + +// DeleteAppRequest generates a "aws/request.Request" representing the +// client's request for the DeleteApp 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 DeleteApp for more information on using the DeleteApp +// 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 DeleteAppRequest method. +// req, resp := client.DeleteAppRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteApp +func (c *ResilienceHub) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, output *DeleteAppOutput) { + op := &request.Operation{ + Name: opDeleteApp, + HTTPMethod: "POST", + HTTPPath: "/delete-app", + } + + if input == nil { + input = &DeleteAppInput{} + } + + output = &DeleteAppOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteApp API operation for AWS Resilience Hub. +// +// Deletes an AWS Resilience Hub application. This is a destructive action that +// can't be undone. +// +// 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 Resilience Hub's +// API operation DeleteApp for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteApp +func (c *ResilienceHub) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error) { + req, out := c.DeleteAppRequest(input) + return out, req.Send() +} + +// DeleteAppWithContext is the same as DeleteApp with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteApp 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 *ResilienceHub) DeleteAppWithContext(ctx aws.Context, input *DeleteAppInput, opts ...request.Option) (*DeleteAppOutput, error) { + req, out := c.DeleteAppRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteAppAssessment = "DeleteAppAssessment" + +// DeleteAppAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAppAssessment 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 DeleteAppAssessment for more information on using the DeleteAppAssessment +// 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 DeleteAppAssessmentRequest method. +// req, resp := client.DeleteAppAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteAppAssessment +func (c *ResilienceHub) DeleteAppAssessmentRequest(input *DeleteAppAssessmentInput) (req *request.Request, output *DeleteAppAssessmentOutput) { + op := &request.Operation{ + Name: opDeleteAppAssessment, + HTTPMethod: "POST", + HTTPPath: "/delete-app-assessment", + } + + if input == nil { + input = &DeleteAppAssessmentInput{} + } + + output = &DeleteAppAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteAppAssessment API operation for AWS Resilience Hub. +// +// Deletes an AWS Resilience Hub application assessment. This is a destructive +// action that can't be undone. +// +// 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 Resilience Hub's +// API operation DeleteAppAssessment for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteAppAssessment +func (c *ResilienceHub) DeleteAppAssessment(input *DeleteAppAssessmentInput) (*DeleteAppAssessmentOutput, error) { + req, out := c.DeleteAppAssessmentRequest(input) + return out, req.Send() +} + +// DeleteAppAssessmentWithContext is the same as DeleteAppAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAppAssessment 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 *ResilienceHub) DeleteAppAssessmentWithContext(ctx aws.Context, input *DeleteAppAssessmentInput, opts ...request.Option) (*DeleteAppAssessmentOutput, error) { + req, out := c.DeleteAppAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteRecommendationTemplate = "DeleteRecommendationTemplate" + +// DeleteRecommendationTemplateRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRecommendationTemplate 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 DeleteRecommendationTemplate for more information on using the DeleteRecommendationTemplate +// 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 DeleteRecommendationTemplateRequest method. +// req, resp := client.DeleteRecommendationTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteRecommendationTemplate +func (c *ResilienceHub) DeleteRecommendationTemplateRequest(input *DeleteRecommendationTemplateInput) (req *request.Request, output *DeleteRecommendationTemplateOutput) { + op := &request.Operation{ + Name: opDeleteRecommendationTemplate, + HTTPMethod: "POST", + HTTPPath: "/delete-recommendation-template", + } + + if input == nil { + input = &DeleteRecommendationTemplateInput{} + } + + output = &DeleteRecommendationTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteRecommendationTemplate API operation for AWS Resilience Hub. +// +// Deletes a recommendation template. This is a destructive action that can't +// be undone. +// +// 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 Resilience Hub's +// API operation DeleteRecommendationTemplate for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteRecommendationTemplate +func (c *ResilienceHub) DeleteRecommendationTemplate(input *DeleteRecommendationTemplateInput) (*DeleteRecommendationTemplateOutput, error) { + req, out := c.DeleteRecommendationTemplateRequest(input) + return out, req.Send() +} + +// DeleteRecommendationTemplateWithContext is the same as DeleteRecommendationTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRecommendationTemplate 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 *ResilienceHub) DeleteRecommendationTemplateWithContext(ctx aws.Context, input *DeleteRecommendationTemplateInput, opts ...request.Option) (*DeleteRecommendationTemplateOutput, error) { + req, out := c.DeleteRecommendationTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteResiliencyPolicy = "DeleteResiliencyPolicy" + +// DeleteResiliencyPolicyRequest generates a "aws/request.Request" representing the +// client's request for the DeleteResiliencyPolicy 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 DeleteResiliencyPolicy for more information on using the DeleteResiliencyPolicy +// 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 DeleteResiliencyPolicyRequest method. +// req, resp := client.DeleteResiliencyPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteResiliencyPolicy +func (c *ResilienceHub) DeleteResiliencyPolicyRequest(input *DeleteResiliencyPolicyInput) (req *request.Request, output *DeleteResiliencyPolicyOutput) { + op := &request.Operation{ + Name: opDeleteResiliencyPolicy, + HTTPMethod: "POST", + HTTPPath: "/delete-resiliency-policy", + } + + if input == nil { + input = &DeleteResiliencyPolicyInput{} + } + + output = &DeleteResiliencyPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteResiliencyPolicy API operation for AWS Resilience Hub. +// +// Deletes a resiliency policy. This is a destructive action that can't be undone. +// +// 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 Resilience Hub's +// API operation DeleteResiliencyPolicy for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DeleteResiliencyPolicy +func (c *ResilienceHub) DeleteResiliencyPolicy(input *DeleteResiliencyPolicyInput) (*DeleteResiliencyPolicyOutput, error) { + req, out := c.DeleteResiliencyPolicyRequest(input) + return out, req.Send() +} + +// DeleteResiliencyPolicyWithContext is the same as DeleteResiliencyPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteResiliencyPolicy 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 *ResilienceHub) DeleteResiliencyPolicyWithContext(ctx aws.Context, input *DeleteResiliencyPolicyInput, opts ...request.Option) (*DeleteResiliencyPolicyOutput, error) { + req, out := c.DeleteResiliencyPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeApp = "DescribeApp" + +// DescribeAppRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApp 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 DescribeApp for more information on using the DescribeApp +// 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 DescribeAppRequest method. +// req, resp := client.DescribeAppRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeApp +func (c *ResilienceHub) DescribeAppRequest(input *DescribeAppInput) (req *request.Request, output *DescribeAppOutput) { + op := &request.Operation{ + Name: opDescribeApp, + HTTPMethod: "POST", + HTTPPath: "/describe-app", + } + + if input == nil { + input = &DescribeAppInput{} + } + + output = &DescribeAppOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeApp API operation for AWS Resilience Hub. +// +// Describes an AWS Resilience Hub application. +// +// 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 Resilience Hub's +// API operation DescribeApp for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeApp +func (c *ResilienceHub) DescribeApp(input *DescribeAppInput) (*DescribeAppOutput, error) { + req, out := c.DescribeAppRequest(input) + return out, req.Send() +} + +// DescribeAppWithContext is the same as DescribeApp with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeApp 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 *ResilienceHub) DescribeAppWithContext(ctx aws.Context, input *DescribeAppInput, opts ...request.Option) (*DescribeAppOutput, error) { + req, out := c.DescribeAppRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeAppAssessment = "DescribeAppAssessment" + +// DescribeAppAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAppAssessment 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 DescribeAppAssessment for more information on using the DescribeAppAssessment +// 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 DescribeAppAssessmentRequest method. +// req, resp := client.DescribeAppAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppAssessment +func (c *ResilienceHub) DescribeAppAssessmentRequest(input *DescribeAppAssessmentInput) (req *request.Request, output *DescribeAppAssessmentOutput) { + op := &request.Operation{ + Name: opDescribeAppAssessment, + HTTPMethod: "POST", + HTTPPath: "/describe-app-assessment", + } + + if input == nil { + input = &DescribeAppAssessmentInput{} + } + + output = &DescribeAppAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeAppAssessment API operation for AWS Resilience Hub. +// +// Describes an assessment for an AWS Resilience Hub application. +// +// 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 Resilience Hub's +// API operation DescribeAppAssessment for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppAssessment +func (c *ResilienceHub) DescribeAppAssessment(input *DescribeAppAssessmentInput) (*DescribeAppAssessmentOutput, error) { + req, out := c.DescribeAppAssessmentRequest(input) + return out, req.Send() +} + +// DescribeAppAssessmentWithContext is the same as DescribeAppAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeAppAssessment 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 *ResilienceHub) DescribeAppAssessmentWithContext(ctx aws.Context, input *DescribeAppAssessmentInput, opts ...request.Option) (*DescribeAppAssessmentOutput, error) { + req, out := c.DescribeAppAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeAppVersionResourcesResolutionStatus = "DescribeAppVersionResourcesResolutionStatus" + +// DescribeAppVersionResourcesResolutionStatusRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAppVersionResourcesResolutionStatus 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 DescribeAppVersionResourcesResolutionStatus for more information on using the DescribeAppVersionResourcesResolutionStatus +// 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 DescribeAppVersionResourcesResolutionStatusRequest method. +// req, resp := client.DescribeAppVersionResourcesResolutionStatusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppVersionResourcesResolutionStatus +func (c *ResilienceHub) DescribeAppVersionResourcesResolutionStatusRequest(input *DescribeAppVersionResourcesResolutionStatusInput) (req *request.Request, output *DescribeAppVersionResourcesResolutionStatusOutput) { + op := &request.Operation{ + Name: opDescribeAppVersionResourcesResolutionStatus, + HTTPMethod: "POST", + HTTPPath: "/describe-app-version-resources-resolution-status", + } + + if input == nil { + input = &DescribeAppVersionResourcesResolutionStatusInput{} + } + + output = &DescribeAppVersionResourcesResolutionStatusOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeAppVersionResourcesResolutionStatus API operation for AWS Resilience Hub. +// +// Returns the resolution status for the specified resolution identifier for +// an application version. If resolutionId is not specified, the current resolution +// status is returned. +// +// 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 Resilience Hub's +// API operation DescribeAppVersionResourcesResolutionStatus for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppVersionResourcesResolutionStatus +func (c *ResilienceHub) DescribeAppVersionResourcesResolutionStatus(input *DescribeAppVersionResourcesResolutionStatusInput) (*DescribeAppVersionResourcesResolutionStatusOutput, error) { + req, out := c.DescribeAppVersionResourcesResolutionStatusRequest(input) + return out, req.Send() +} + +// DescribeAppVersionResourcesResolutionStatusWithContext is the same as DescribeAppVersionResourcesResolutionStatus with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeAppVersionResourcesResolutionStatus 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 *ResilienceHub) DescribeAppVersionResourcesResolutionStatusWithContext(ctx aws.Context, input *DescribeAppVersionResourcesResolutionStatusInput, opts ...request.Option) (*DescribeAppVersionResourcesResolutionStatusOutput, error) { + req, out := c.DescribeAppVersionResourcesResolutionStatusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeAppVersionTemplate = "DescribeAppVersionTemplate" + +// DescribeAppVersionTemplateRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAppVersionTemplate 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 DescribeAppVersionTemplate for more information on using the DescribeAppVersionTemplate +// 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 DescribeAppVersionTemplateRequest method. +// req, resp := client.DescribeAppVersionTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppVersionTemplate +func (c *ResilienceHub) DescribeAppVersionTemplateRequest(input *DescribeAppVersionTemplateInput) (req *request.Request, output *DescribeAppVersionTemplateOutput) { + op := &request.Operation{ + Name: opDescribeAppVersionTemplate, + HTTPMethod: "POST", + HTTPPath: "/describe-app-version-template", + } + + if input == nil { + input = &DescribeAppVersionTemplateInput{} + } + + output = &DescribeAppVersionTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeAppVersionTemplate API operation for AWS Resilience Hub. +// +// Describes details about an AWS Resilience Hub +// +// 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 Resilience Hub's +// API operation DescribeAppVersionTemplate for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeAppVersionTemplate +func (c *ResilienceHub) DescribeAppVersionTemplate(input *DescribeAppVersionTemplateInput) (*DescribeAppVersionTemplateOutput, error) { + req, out := c.DescribeAppVersionTemplateRequest(input) + return out, req.Send() +} + +// DescribeAppVersionTemplateWithContext is the same as DescribeAppVersionTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeAppVersionTemplate 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 *ResilienceHub) DescribeAppVersionTemplateWithContext(ctx aws.Context, input *DescribeAppVersionTemplateInput, opts ...request.Option) (*DescribeAppVersionTemplateOutput, error) { + req, out := c.DescribeAppVersionTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDraftAppVersionResourcesImportStatus = "DescribeDraftAppVersionResourcesImportStatus" + +// DescribeDraftAppVersionResourcesImportStatusRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDraftAppVersionResourcesImportStatus 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 DescribeDraftAppVersionResourcesImportStatus for more information on using the DescribeDraftAppVersionResourcesImportStatus +// 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 DescribeDraftAppVersionResourcesImportStatusRequest method. +// req, resp := client.DescribeDraftAppVersionResourcesImportStatusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeDraftAppVersionResourcesImportStatus +func (c *ResilienceHub) DescribeDraftAppVersionResourcesImportStatusRequest(input *DescribeDraftAppVersionResourcesImportStatusInput) (req *request.Request, output *DescribeDraftAppVersionResourcesImportStatusOutput) { + op := &request.Operation{ + Name: opDescribeDraftAppVersionResourcesImportStatus, + HTTPMethod: "POST", + HTTPPath: "/describe-draft-app-version-resources-import-status", + } + + if input == nil { + input = &DescribeDraftAppVersionResourcesImportStatusInput{} + } + + output = &DescribeDraftAppVersionResourcesImportStatusOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDraftAppVersionResourcesImportStatus API operation for AWS Resilience Hub. +// +// Describes the status of importing resources to an application version. +// +// 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 Resilience Hub's +// API operation DescribeDraftAppVersionResourcesImportStatus for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeDraftAppVersionResourcesImportStatus +func (c *ResilienceHub) DescribeDraftAppVersionResourcesImportStatus(input *DescribeDraftAppVersionResourcesImportStatusInput) (*DescribeDraftAppVersionResourcesImportStatusOutput, error) { + req, out := c.DescribeDraftAppVersionResourcesImportStatusRequest(input) + return out, req.Send() +} + +// DescribeDraftAppVersionResourcesImportStatusWithContext is the same as DescribeDraftAppVersionResourcesImportStatus with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDraftAppVersionResourcesImportStatus 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 *ResilienceHub) DescribeDraftAppVersionResourcesImportStatusWithContext(ctx aws.Context, input *DescribeDraftAppVersionResourcesImportStatusInput, opts ...request.Option) (*DescribeDraftAppVersionResourcesImportStatusOutput, error) { + req, out := c.DescribeDraftAppVersionResourcesImportStatusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeResiliencyPolicy = "DescribeResiliencyPolicy" + +// DescribeResiliencyPolicyRequest generates a "aws/request.Request" representing the +// client's request for the DescribeResiliencyPolicy 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 DescribeResiliencyPolicy for more information on using the DescribeResiliencyPolicy +// 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 DescribeResiliencyPolicyRequest method. +// req, resp := client.DescribeResiliencyPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeResiliencyPolicy +func (c *ResilienceHub) DescribeResiliencyPolicyRequest(input *DescribeResiliencyPolicyInput) (req *request.Request, output *DescribeResiliencyPolicyOutput) { + op := &request.Operation{ + Name: opDescribeResiliencyPolicy, + HTTPMethod: "POST", + HTTPPath: "/describe-resiliency-policy", + } + + if input == nil { + input = &DescribeResiliencyPolicyInput{} + } + + output = &DescribeResiliencyPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeResiliencyPolicy API operation for AWS Resilience Hub. +// +// Describes a specified resiliency policy for an AWS Resilience Hub application. +// The returned policy object includes creation time, data location constraints, +// the Amazon Resource Name (ARN) for the policy, tags, tier, and more. +// +// 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 Resilience Hub's +// API operation DescribeResiliencyPolicy for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/DescribeResiliencyPolicy +func (c *ResilienceHub) DescribeResiliencyPolicy(input *DescribeResiliencyPolicyInput) (*DescribeResiliencyPolicyOutput, error) { + req, out := c.DescribeResiliencyPolicyRequest(input) + return out, req.Send() +} + +// DescribeResiliencyPolicyWithContext is the same as DescribeResiliencyPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeResiliencyPolicy 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 *ResilienceHub) DescribeResiliencyPolicyWithContext(ctx aws.Context, input *DescribeResiliencyPolicyInput, opts ...request.Option) (*DescribeResiliencyPolicyOutput, error) { + req, out := c.DescribeResiliencyPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opImportResourcesToDraftAppVersion = "ImportResourcesToDraftAppVersion" + +// ImportResourcesToDraftAppVersionRequest generates a "aws/request.Request" representing the +// client's request for the ImportResourcesToDraftAppVersion 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 ImportResourcesToDraftAppVersion for more information on using the ImportResourcesToDraftAppVersion +// 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 ImportResourcesToDraftAppVersionRequest method. +// req, resp := client.ImportResourcesToDraftAppVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ImportResourcesToDraftAppVersion +func (c *ResilienceHub) ImportResourcesToDraftAppVersionRequest(input *ImportResourcesToDraftAppVersionInput) (req *request.Request, output *ImportResourcesToDraftAppVersionOutput) { + op := &request.Operation{ + Name: opImportResourcesToDraftAppVersion, + HTTPMethod: "POST", + HTTPPath: "/import-resources-to-draft-app-version", + } + + if input == nil { + input = &ImportResourcesToDraftAppVersionInput{} + } + + output = &ImportResourcesToDraftAppVersionOutput{} + req = c.newRequest(op, input, output) + return +} + +// ImportResourcesToDraftAppVersion API operation for AWS Resilience Hub. +// +// Imports resources from sources such as a CloudFormation stack, resource-groups, +// or application registry app to a draft application version. +// +// 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 Resilience Hub's +// API operation ImportResourcesToDraftAppVersion for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ImportResourcesToDraftAppVersion +func (c *ResilienceHub) ImportResourcesToDraftAppVersion(input *ImportResourcesToDraftAppVersionInput) (*ImportResourcesToDraftAppVersionOutput, error) { + req, out := c.ImportResourcesToDraftAppVersionRequest(input) + return out, req.Send() +} + +// ImportResourcesToDraftAppVersionWithContext is the same as ImportResourcesToDraftAppVersion with the addition of +// the ability to pass a context and additional request options. +// +// See ImportResourcesToDraftAppVersion 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 *ResilienceHub) ImportResourcesToDraftAppVersionWithContext(ctx aws.Context, input *ImportResourcesToDraftAppVersionInput, opts ...request.Option) (*ImportResourcesToDraftAppVersionOutput, error) { + req, out := c.ImportResourcesToDraftAppVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListAlarmRecommendations = "ListAlarmRecommendations" + +// ListAlarmRecommendationsRequest generates a "aws/request.Request" representing the +// client's request for the ListAlarmRecommendations 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 ListAlarmRecommendations for more information on using the ListAlarmRecommendations +// 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 ListAlarmRecommendationsRequest method. +// req, resp := client.ListAlarmRecommendationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAlarmRecommendations +func (c *ResilienceHub) ListAlarmRecommendationsRequest(input *ListAlarmRecommendationsInput) (req *request.Request, output *ListAlarmRecommendationsOutput) { + op := &request.Operation{ + Name: opListAlarmRecommendations, + HTTPMethod: "POST", + HTTPPath: "/list-alarm-recommendations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAlarmRecommendationsInput{} + } + + output = &ListAlarmRecommendationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAlarmRecommendations API operation for AWS Resilience Hub. +// +// Lists the alarm recommendations for a AWS Resilience Hub application. +// +// 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 Resilience Hub's +// API operation ListAlarmRecommendations for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAlarmRecommendations +func (c *ResilienceHub) ListAlarmRecommendations(input *ListAlarmRecommendationsInput) (*ListAlarmRecommendationsOutput, error) { + req, out := c.ListAlarmRecommendationsRequest(input) + return out, req.Send() +} + +// ListAlarmRecommendationsWithContext is the same as ListAlarmRecommendations with the addition of +// the ability to pass a context and additional request options. +// +// See ListAlarmRecommendations 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 *ResilienceHub) ListAlarmRecommendationsWithContext(ctx aws.Context, input *ListAlarmRecommendationsInput, opts ...request.Option) (*ListAlarmRecommendationsOutput, error) { + req, out := c.ListAlarmRecommendationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAlarmRecommendationsPages iterates over the pages of a ListAlarmRecommendations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAlarmRecommendations 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 ListAlarmRecommendations operation. +// pageNum := 0 +// err := client.ListAlarmRecommendationsPages(params, +// func(page *resiliencehub.ListAlarmRecommendationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAlarmRecommendationsPages(input *ListAlarmRecommendationsInput, fn func(*ListAlarmRecommendationsOutput, bool) bool) error { + return c.ListAlarmRecommendationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAlarmRecommendationsPagesWithContext same as ListAlarmRecommendationsPages 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 *ResilienceHub) ListAlarmRecommendationsPagesWithContext(ctx aws.Context, input *ListAlarmRecommendationsInput, fn func(*ListAlarmRecommendationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAlarmRecommendationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAlarmRecommendationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAlarmRecommendationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppAssessments = "ListAppAssessments" + +// ListAppAssessmentsRequest generates a "aws/request.Request" representing the +// client's request for the ListAppAssessments 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 ListAppAssessments for more information on using the ListAppAssessments +// 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 ListAppAssessmentsRequest method. +// req, resp := client.ListAppAssessmentsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppAssessments +func (c *ResilienceHub) ListAppAssessmentsRequest(input *ListAppAssessmentsInput) (req *request.Request, output *ListAppAssessmentsOutput) { + op := &request.Operation{ + Name: opListAppAssessments, + HTTPMethod: "GET", + HTTPPath: "/list-app-assessments", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppAssessmentsInput{} + } + + output = &ListAppAssessmentsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppAssessments API operation for AWS Resilience Hub. +// +// Lists the assessments for an AWS Resilience Hub application. You can use +// request parameters to refine the results for the response object. +// +// 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 Resilience Hub's +// API operation ListAppAssessments for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppAssessments +func (c *ResilienceHub) ListAppAssessments(input *ListAppAssessmentsInput) (*ListAppAssessmentsOutput, error) { + req, out := c.ListAppAssessmentsRequest(input) + return out, req.Send() +} + +// ListAppAssessmentsWithContext is the same as ListAppAssessments with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppAssessments 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 *ResilienceHub) ListAppAssessmentsWithContext(ctx aws.Context, input *ListAppAssessmentsInput, opts ...request.Option) (*ListAppAssessmentsOutput, error) { + req, out := c.ListAppAssessmentsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppAssessmentsPages iterates over the pages of a ListAppAssessments operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppAssessments 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 ListAppAssessments operation. +// pageNum := 0 +// err := client.ListAppAssessmentsPages(params, +// func(page *resiliencehub.ListAppAssessmentsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppAssessmentsPages(input *ListAppAssessmentsInput, fn func(*ListAppAssessmentsOutput, bool) bool) error { + return c.ListAppAssessmentsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppAssessmentsPagesWithContext same as ListAppAssessmentsPages 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 *ResilienceHub) ListAppAssessmentsPagesWithContext(ctx aws.Context, input *ListAppAssessmentsInput, fn func(*ListAppAssessmentsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppAssessmentsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppAssessmentsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppAssessmentsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppComponentCompliances = "ListAppComponentCompliances" + +// ListAppComponentCompliancesRequest generates a "aws/request.Request" representing the +// client's request for the ListAppComponentCompliances 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 ListAppComponentCompliances for more information on using the ListAppComponentCompliances +// 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 ListAppComponentCompliancesRequest method. +// req, resp := client.ListAppComponentCompliancesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppComponentCompliances +func (c *ResilienceHub) ListAppComponentCompliancesRequest(input *ListAppComponentCompliancesInput) (req *request.Request, output *ListAppComponentCompliancesOutput) { + op := &request.Operation{ + Name: opListAppComponentCompliances, + HTTPMethod: "POST", + HTTPPath: "/list-app-component-compliances", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppComponentCompliancesInput{} + } + + output = &ListAppComponentCompliancesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppComponentCompliances API operation for AWS Resilience Hub. +// +// Lists the compliances for an AWS Resilience Hub component. +// +// 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 Resilience Hub's +// API operation ListAppComponentCompliances for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppComponentCompliances +func (c *ResilienceHub) ListAppComponentCompliances(input *ListAppComponentCompliancesInput) (*ListAppComponentCompliancesOutput, error) { + req, out := c.ListAppComponentCompliancesRequest(input) + return out, req.Send() +} + +// ListAppComponentCompliancesWithContext is the same as ListAppComponentCompliances with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppComponentCompliances 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 *ResilienceHub) ListAppComponentCompliancesWithContext(ctx aws.Context, input *ListAppComponentCompliancesInput, opts ...request.Option) (*ListAppComponentCompliancesOutput, error) { + req, out := c.ListAppComponentCompliancesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppComponentCompliancesPages iterates over the pages of a ListAppComponentCompliances operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppComponentCompliances 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 ListAppComponentCompliances operation. +// pageNum := 0 +// err := client.ListAppComponentCompliancesPages(params, +// func(page *resiliencehub.ListAppComponentCompliancesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppComponentCompliancesPages(input *ListAppComponentCompliancesInput, fn func(*ListAppComponentCompliancesOutput, bool) bool) error { + return c.ListAppComponentCompliancesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppComponentCompliancesPagesWithContext same as ListAppComponentCompliancesPages 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 *ResilienceHub) ListAppComponentCompliancesPagesWithContext(ctx aws.Context, input *ListAppComponentCompliancesInput, fn func(*ListAppComponentCompliancesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppComponentCompliancesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppComponentCompliancesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppComponentCompliancesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppComponentRecommendations = "ListAppComponentRecommendations" + +// ListAppComponentRecommendationsRequest generates a "aws/request.Request" representing the +// client's request for the ListAppComponentRecommendations 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 ListAppComponentRecommendations for more information on using the ListAppComponentRecommendations +// 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 ListAppComponentRecommendationsRequest method. +// req, resp := client.ListAppComponentRecommendationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppComponentRecommendations +func (c *ResilienceHub) ListAppComponentRecommendationsRequest(input *ListAppComponentRecommendationsInput) (req *request.Request, output *ListAppComponentRecommendationsOutput) { + op := &request.Operation{ + Name: opListAppComponentRecommendations, + HTTPMethod: "POST", + HTTPPath: "/list-app-component-recommendations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppComponentRecommendationsInput{} + } + + output = &ListAppComponentRecommendationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppComponentRecommendations API operation for AWS Resilience Hub. +// +// Lists the recommendations for an AWS Resilience Hub component. +// +// 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 Resilience Hub's +// API operation ListAppComponentRecommendations for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppComponentRecommendations +func (c *ResilienceHub) ListAppComponentRecommendations(input *ListAppComponentRecommendationsInput) (*ListAppComponentRecommendationsOutput, error) { + req, out := c.ListAppComponentRecommendationsRequest(input) + return out, req.Send() +} + +// ListAppComponentRecommendationsWithContext is the same as ListAppComponentRecommendations with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppComponentRecommendations 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 *ResilienceHub) ListAppComponentRecommendationsWithContext(ctx aws.Context, input *ListAppComponentRecommendationsInput, opts ...request.Option) (*ListAppComponentRecommendationsOutput, error) { + req, out := c.ListAppComponentRecommendationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppComponentRecommendationsPages iterates over the pages of a ListAppComponentRecommendations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppComponentRecommendations 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 ListAppComponentRecommendations operation. +// pageNum := 0 +// err := client.ListAppComponentRecommendationsPages(params, +// func(page *resiliencehub.ListAppComponentRecommendationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppComponentRecommendationsPages(input *ListAppComponentRecommendationsInput, fn func(*ListAppComponentRecommendationsOutput, bool) bool) error { + return c.ListAppComponentRecommendationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppComponentRecommendationsPagesWithContext same as ListAppComponentRecommendationsPages 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 *ResilienceHub) ListAppComponentRecommendationsPagesWithContext(ctx aws.Context, input *ListAppComponentRecommendationsInput, fn func(*ListAppComponentRecommendationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppComponentRecommendationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppComponentRecommendationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppComponentRecommendationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppVersionResourceMappings = "ListAppVersionResourceMappings" + +// ListAppVersionResourceMappingsRequest generates a "aws/request.Request" representing the +// client's request for the ListAppVersionResourceMappings 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 ListAppVersionResourceMappings for more information on using the ListAppVersionResourceMappings +// 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 ListAppVersionResourceMappingsRequest method. +// req, resp := client.ListAppVersionResourceMappingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersionResourceMappings +func (c *ResilienceHub) ListAppVersionResourceMappingsRequest(input *ListAppVersionResourceMappingsInput) (req *request.Request, output *ListAppVersionResourceMappingsOutput) { + op := &request.Operation{ + Name: opListAppVersionResourceMappings, + HTTPMethod: "POST", + HTTPPath: "/list-app-version-resource-mappings", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppVersionResourceMappingsInput{} + } + + output = &ListAppVersionResourceMappingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppVersionResourceMappings API operation for AWS Resilience Hub. +// +// Lists how the resources in an application version are mapped/sourced from. +// Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, +// or an application registry app. +// +// 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 Resilience Hub's +// API operation ListAppVersionResourceMappings for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersionResourceMappings +func (c *ResilienceHub) ListAppVersionResourceMappings(input *ListAppVersionResourceMappingsInput) (*ListAppVersionResourceMappingsOutput, error) { + req, out := c.ListAppVersionResourceMappingsRequest(input) + return out, req.Send() +} + +// ListAppVersionResourceMappingsWithContext is the same as ListAppVersionResourceMappings with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppVersionResourceMappings 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 *ResilienceHub) ListAppVersionResourceMappingsWithContext(ctx aws.Context, input *ListAppVersionResourceMappingsInput, opts ...request.Option) (*ListAppVersionResourceMappingsOutput, error) { + req, out := c.ListAppVersionResourceMappingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppVersionResourceMappingsPages iterates over the pages of a ListAppVersionResourceMappings operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppVersionResourceMappings 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 ListAppVersionResourceMappings operation. +// pageNum := 0 +// err := client.ListAppVersionResourceMappingsPages(params, +// func(page *resiliencehub.ListAppVersionResourceMappingsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppVersionResourceMappingsPages(input *ListAppVersionResourceMappingsInput, fn func(*ListAppVersionResourceMappingsOutput, bool) bool) error { + return c.ListAppVersionResourceMappingsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppVersionResourceMappingsPagesWithContext same as ListAppVersionResourceMappingsPages 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 *ResilienceHub) ListAppVersionResourceMappingsPagesWithContext(ctx aws.Context, input *ListAppVersionResourceMappingsInput, fn func(*ListAppVersionResourceMappingsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppVersionResourceMappingsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppVersionResourceMappingsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppVersionResourceMappingsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppVersionResources = "ListAppVersionResources" + +// ListAppVersionResourcesRequest generates a "aws/request.Request" representing the +// client's request for the ListAppVersionResources 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 ListAppVersionResources for more information on using the ListAppVersionResources +// 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 ListAppVersionResourcesRequest method. +// req, resp := client.ListAppVersionResourcesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersionResources +func (c *ResilienceHub) ListAppVersionResourcesRequest(input *ListAppVersionResourcesInput) (req *request.Request, output *ListAppVersionResourcesOutput) { + op := &request.Operation{ + Name: opListAppVersionResources, + HTTPMethod: "POST", + HTTPPath: "/list-app-version-resources", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppVersionResourcesInput{} + } + + output = &ListAppVersionResourcesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppVersionResources API operation for AWS Resilience Hub. +// +// Lists all the resources in an application version. +// +// 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 Resilience Hub's +// API operation ListAppVersionResources for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersionResources +func (c *ResilienceHub) ListAppVersionResources(input *ListAppVersionResourcesInput) (*ListAppVersionResourcesOutput, error) { + req, out := c.ListAppVersionResourcesRequest(input) + return out, req.Send() +} + +// ListAppVersionResourcesWithContext is the same as ListAppVersionResources with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppVersionResources 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 *ResilienceHub) ListAppVersionResourcesWithContext(ctx aws.Context, input *ListAppVersionResourcesInput, opts ...request.Option) (*ListAppVersionResourcesOutput, error) { + req, out := c.ListAppVersionResourcesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppVersionResourcesPages iterates over the pages of a ListAppVersionResources operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppVersionResources 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 ListAppVersionResources operation. +// pageNum := 0 +// err := client.ListAppVersionResourcesPages(params, +// func(page *resiliencehub.ListAppVersionResourcesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppVersionResourcesPages(input *ListAppVersionResourcesInput, fn func(*ListAppVersionResourcesOutput, bool) bool) error { + return c.ListAppVersionResourcesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppVersionResourcesPagesWithContext same as ListAppVersionResourcesPages 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 *ResilienceHub) ListAppVersionResourcesPagesWithContext(ctx aws.Context, input *ListAppVersionResourcesInput, fn func(*ListAppVersionResourcesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppVersionResourcesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppVersionResourcesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppVersionResourcesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAppVersions = "ListAppVersions" + +// ListAppVersionsRequest generates a "aws/request.Request" representing the +// client's request for the ListAppVersions 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 ListAppVersions for more information on using the ListAppVersions +// 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 ListAppVersionsRequest method. +// req, resp := client.ListAppVersionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersions +func (c *ResilienceHub) ListAppVersionsRequest(input *ListAppVersionsInput) (req *request.Request, output *ListAppVersionsOutput) { + op := &request.Operation{ + Name: opListAppVersions, + HTTPMethod: "POST", + HTTPPath: "/list-app-versions", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppVersionsInput{} + } + + output = &ListAppVersionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAppVersions API operation for AWS Resilience Hub. +// +// Lists the different versions for the Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListAppVersions for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListAppVersions +func (c *ResilienceHub) ListAppVersions(input *ListAppVersionsInput) (*ListAppVersionsOutput, error) { + req, out := c.ListAppVersionsRequest(input) + return out, req.Send() +} + +// ListAppVersionsWithContext is the same as ListAppVersions with the addition of +// the ability to pass a context and additional request options. +// +// See ListAppVersions 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 *ResilienceHub) ListAppVersionsWithContext(ctx aws.Context, input *ListAppVersionsInput, opts ...request.Option) (*ListAppVersionsOutput, error) { + req, out := c.ListAppVersionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppVersionsPages iterates over the pages of a ListAppVersions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAppVersions 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 ListAppVersions operation. +// pageNum := 0 +// err := client.ListAppVersionsPages(params, +// func(page *resiliencehub.ListAppVersionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppVersionsPages(input *ListAppVersionsInput, fn func(*ListAppVersionsOutput, bool) bool) error { + return c.ListAppVersionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppVersionsPagesWithContext same as ListAppVersionsPages 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 *ResilienceHub) ListAppVersionsPagesWithContext(ctx aws.Context, input *ListAppVersionsInput, fn func(*ListAppVersionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppVersionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppVersionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppVersionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListApps = "ListApps" + +// ListAppsRequest generates a "aws/request.Request" representing the +// client's request for the ListApps 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 ListApps for more information on using the ListApps +// 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 ListAppsRequest method. +// req, resp := client.ListAppsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListApps +func (c *ResilienceHub) ListAppsRequest(input *ListAppsInput) (req *request.Request, output *ListAppsOutput) { + op := &request.Operation{ + Name: opListApps, + HTTPMethod: "GET", + HTTPPath: "/list-apps", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAppsInput{} + } + + output = &ListAppsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApps API operation for AWS Resilience Hub. +// +// Lists your Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListApps for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListApps +func (c *ResilienceHub) ListApps(input *ListAppsInput) (*ListAppsOutput, error) { + req, out := c.ListAppsRequest(input) + return out, req.Send() +} + +// ListAppsWithContext is the same as ListApps with the addition of +// the ability to pass a context and additional request options. +// +// See ListApps 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 *ResilienceHub) ListAppsWithContext(ctx aws.Context, input *ListAppsInput, opts ...request.Option) (*ListAppsOutput, error) { + req, out := c.ListAppsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAppsPages iterates over the pages of a ListApps operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApps 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 ListApps operation. +// pageNum := 0 +// err := client.ListAppsPages(params, +// func(page *resiliencehub.ListAppsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListAppsPages(input *ListAppsInput, fn func(*ListAppsOutput, bool) bool) error { + return c.ListAppsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAppsPagesWithContext same as ListAppsPages 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 *ResilienceHub) ListAppsPagesWithContext(ctx aws.Context, input *ListAppsInput, fn func(*ListAppsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAppsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAppsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAppsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRecommendationTemplates = "ListRecommendationTemplates" + +// ListRecommendationTemplatesRequest generates a "aws/request.Request" representing the +// client's request for the ListRecommendationTemplates 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 ListRecommendationTemplates for more information on using the ListRecommendationTemplates +// 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 ListRecommendationTemplatesRequest method. +// req, resp := client.ListRecommendationTemplatesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListRecommendationTemplates +func (c *ResilienceHub) ListRecommendationTemplatesRequest(input *ListRecommendationTemplatesInput) (req *request.Request, output *ListRecommendationTemplatesOutput) { + op := &request.Operation{ + Name: opListRecommendationTemplates, + HTTPMethod: "GET", + HTTPPath: "/list-recommendation-templates", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRecommendationTemplatesInput{} + } + + output = &ListRecommendationTemplatesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRecommendationTemplates API operation for AWS Resilience Hub. +// +// Lists the recommendation templates for the Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListRecommendationTemplates for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListRecommendationTemplates +func (c *ResilienceHub) ListRecommendationTemplates(input *ListRecommendationTemplatesInput) (*ListRecommendationTemplatesOutput, error) { + req, out := c.ListRecommendationTemplatesRequest(input) + return out, req.Send() +} + +// ListRecommendationTemplatesWithContext is the same as ListRecommendationTemplates with the addition of +// the ability to pass a context and additional request options. +// +// See ListRecommendationTemplates 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 *ResilienceHub) ListRecommendationTemplatesWithContext(ctx aws.Context, input *ListRecommendationTemplatesInput, opts ...request.Option) (*ListRecommendationTemplatesOutput, error) { + req, out := c.ListRecommendationTemplatesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRecommendationTemplatesPages iterates over the pages of a ListRecommendationTemplates operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRecommendationTemplates 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 ListRecommendationTemplates operation. +// pageNum := 0 +// err := client.ListRecommendationTemplatesPages(params, +// func(page *resiliencehub.ListRecommendationTemplatesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListRecommendationTemplatesPages(input *ListRecommendationTemplatesInput, fn func(*ListRecommendationTemplatesOutput, bool) bool) error { + return c.ListRecommendationTemplatesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRecommendationTemplatesPagesWithContext same as ListRecommendationTemplatesPages 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 *ResilienceHub) ListRecommendationTemplatesPagesWithContext(ctx aws.Context, input *ListRecommendationTemplatesInput, fn func(*ListRecommendationTemplatesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRecommendationTemplatesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRecommendationTemplatesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRecommendationTemplatesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListResiliencyPolicies = "ListResiliencyPolicies" + +// ListResiliencyPoliciesRequest generates a "aws/request.Request" representing the +// client's request for the ListResiliencyPolicies 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 ListResiliencyPolicies for more information on using the ListResiliencyPolicies +// 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 ListResiliencyPoliciesRequest method. +// req, resp := client.ListResiliencyPoliciesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListResiliencyPolicies +func (c *ResilienceHub) ListResiliencyPoliciesRequest(input *ListResiliencyPoliciesInput) (req *request.Request, output *ListResiliencyPoliciesOutput) { + op := &request.Operation{ + Name: opListResiliencyPolicies, + HTTPMethod: "GET", + HTTPPath: "/list-resiliency-policies", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListResiliencyPoliciesInput{} + } + + output = &ListResiliencyPoliciesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListResiliencyPolicies API operation for AWS Resilience Hub. +// +// Lists the resiliency policies for the Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListResiliencyPolicies for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListResiliencyPolicies +func (c *ResilienceHub) ListResiliencyPolicies(input *ListResiliencyPoliciesInput) (*ListResiliencyPoliciesOutput, error) { + req, out := c.ListResiliencyPoliciesRequest(input) + return out, req.Send() +} + +// ListResiliencyPoliciesWithContext is the same as ListResiliencyPolicies with the addition of +// the ability to pass a context and additional request options. +// +// See ListResiliencyPolicies 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 *ResilienceHub) ListResiliencyPoliciesWithContext(ctx aws.Context, input *ListResiliencyPoliciesInput, opts ...request.Option) (*ListResiliencyPoliciesOutput, error) { + req, out := c.ListResiliencyPoliciesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListResiliencyPoliciesPages iterates over the pages of a ListResiliencyPolicies operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListResiliencyPolicies 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 ListResiliencyPolicies operation. +// pageNum := 0 +// err := client.ListResiliencyPoliciesPages(params, +// func(page *resiliencehub.ListResiliencyPoliciesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListResiliencyPoliciesPages(input *ListResiliencyPoliciesInput, fn func(*ListResiliencyPoliciesOutput, bool) bool) error { + return c.ListResiliencyPoliciesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListResiliencyPoliciesPagesWithContext same as ListResiliencyPoliciesPages 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 *ResilienceHub) ListResiliencyPoliciesPagesWithContext(ctx aws.Context, input *ListResiliencyPoliciesInput, fn func(*ListResiliencyPoliciesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListResiliencyPoliciesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListResiliencyPoliciesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListResiliencyPoliciesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSopRecommendations = "ListSopRecommendations" + +// ListSopRecommendationsRequest generates a "aws/request.Request" representing the +// client's request for the ListSopRecommendations 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 ListSopRecommendations for more information on using the ListSopRecommendations +// 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 ListSopRecommendationsRequest method. +// req, resp := client.ListSopRecommendationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListSopRecommendations +func (c *ResilienceHub) ListSopRecommendationsRequest(input *ListSopRecommendationsInput) (req *request.Request, output *ListSopRecommendationsOutput) { + op := &request.Operation{ + Name: opListSopRecommendations, + HTTPMethod: "POST", + HTTPPath: "/list-sop-recommendations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSopRecommendationsInput{} + } + + output = &ListSopRecommendationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSopRecommendations API operation for AWS Resilience Hub. +// +// Lists the standard operating procedure (SOP) recommendations for the Resilience +// Hub applications. +// +// 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 Resilience Hub's +// API operation ListSopRecommendations for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListSopRecommendations +func (c *ResilienceHub) ListSopRecommendations(input *ListSopRecommendationsInput) (*ListSopRecommendationsOutput, error) { + req, out := c.ListSopRecommendationsRequest(input) + return out, req.Send() +} + +// ListSopRecommendationsWithContext is the same as ListSopRecommendations with the addition of +// the ability to pass a context and additional request options. +// +// See ListSopRecommendations 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 *ResilienceHub) ListSopRecommendationsWithContext(ctx aws.Context, input *ListSopRecommendationsInput, opts ...request.Option) (*ListSopRecommendationsOutput, error) { + req, out := c.ListSopRecommendationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSopRecommendationsPages iterates over the pages of a ListSopRecommendations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSopRecommendations 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 ListSopRecommendations operation. +// pageNum := 0 +// err := client.ListSopRecommendationsPages(params, +// func(page *resiliencehub.ListSopRecommendationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListSopRecommendationsPages(input *ListSopRecommendationsInput, fn func(*ListSopRecommendationsOutput, bool) bool) error { + return c.ListSopRecommendationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSopRecommendationsPagesWithContext same as ListSopRecommendationsPages 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 *ResilienceHub) ListSopRecommendationsPagesWithContext(ctx aws.Context, input *ListSopRecommendationsInput, fn func(*ListSopRecommendationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSopRecommendationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSopRecommendationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSopRecommendationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSuggestedResiliencyPolicies = "ListSuggestedResiliencyPolicies" + +// ListSuggestedResiliencyPoliciesRequest generates a "aws/request.Request" representing the +// client's request for the ListSuggestedResiliencyPolicies 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 ListSuggestedResiliencyPolicies for more information on using the ListSuggestedResiliencyPolicies +// 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 ListSuggestedResiliencyPoliciesRequest method. +// req, resp := client.ListSuggestedResiliencyPoliciesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListSuggestedResiliencyPolicies +func (c *ResilienceHub) ListSuggestedResiliencyPoliciesRequest(input *ListSuggestedResiliencyPoliciesInput) (req *request.Request, output *ListSuggestedResiliencyPoliciesOutput) { + op := &request.Operation{ + Name: opListSuggestedResiliencyPolicies, + HTTPMethod: "GET", + HTTPPath: "/list-suggested-resiliency-policies", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSuggestedResiliencyPoliciesInput{} + } + + output = &ListSuggestedResiliencyPoliciesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSuggestedResiliencyPolicies API operation for AWS Resilience Hub. +// +// Lists the suggested resiliency policies for the Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListSuggestedResiliencyPolicies for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListSuggestedResiliencyPolicies +func (c *ResilienceHub) ListSuggestedResiliencyPolicies(input *ListSuggestedResiliencyPoliciesInput) (*ListSuggestedResiliencyPoliciesOutput, error) { + req, out := c.ListSuggestedResiliencyPoliciesRequest(input) + return out, req.Send() +} + +// ListSuggestedResiliencyPoliciesWithContext is the same as ListSuggestedResiliencyPolicies with the addition of +// the ability to pass a context and additional request options. +// +// See ListSuggestedResiliencyPolicies 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 *ResilienceHub) ListSuggestedResiliencyPoliciesWithContext(ctx aws.Context, input *ListSuggestedResiliencyPoliciesInput, opts ...request.Option) (*ListSuggestedResiliencyPoliciesOutput, error) { + req, out := c.ListSuggestedResiliencyPoliciesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSuggestedResiliencyPoliciesPages iterates over the pages of a ListSuggestedResiliencyPolicies operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSuggestedResiliencyPolicies 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 ListSuggestedResiliencyPolicies operation. +// pageNum := 0 +// err := client.ListSuggestedResiliencyPoliciesPages(params, +// func(page *resiliencehub.ListSuggestedResiliencyPoliciesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListSuggestedResiliencyPoliciesPages(input *ListSuggestedResiliencyPoliciesInput, fn func(*ListSuggestedResiliencyPoliciesOutput, bool) bool) error { + return c.ListSuggestedResiliencyPoliciesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSuggestedResiliencyPoliciesPagesWithContext same as ListSuggestedResiliencyPoliciesPages 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 *ResilienceHub) ListSuggestedResiliencyPoliciesPagesWithContext(ctx aws.Context, input *ListSuggestedResiliencyPoliciesInput, fn func(*ListSuggestedResiliencyPoliciesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSuggestedResiliencyPoliciesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSuggestedResiliencyPoliciesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSuggestedResiliencyPoliciesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource +// 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 ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListTagsForResource +func (c *ResilienceHub) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Resilience Hub. +// +// Lists the tags for your resources in your Resilience Hub applications. +// +// 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 Resilience Hub's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListTagsForResource +func (c *ResilienceHub) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource 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 *ResilienceHub) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListTestRecommendations = "ListTestRecommendations" + +// ListTestRecommendationsRequest generates a "aws/request.Request" representing the +// client's request for the ListTestRecommendations 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 ListTestRecommendations for more information on using the ListTestRecommendations +// 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 ListTestRecommendationsRequest method. +// req, resp := client.ListTestRecommendationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListTestRecommendations +func (c *ResilienceHub) ListTestRecommendationsRequest(input *ListTestRecommendationsInput) (req *request.Request, output *ListTestRecommendationsOutput) { + op := &request.Operation{ + Name: opListTestRecommendations, + HTTPMethod: "POST", + HTTPPath: "/list-test-recommendations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListTestRecommendationsInput{} + } + + output = &ListTestRecommendationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTestRecommendations API operation for AWS Resilience Hub. +// +// Lists the test recommendations for the Resilience Hub application. +// +// 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 Resilience Hub's +// API operation ListTestRecommendations for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListTestRecommendations +func (c *ResilienceHub) ListTestRecommendations(input *ListTestRecommendationsInput) (*ListTestRecommendationsOutput, error) { + req, out := c.ListTestRecommendationsRequest(input) + return out, req.Send() +} + +// ListTestRecommendationsWithContext is the same as ListTestRecommendations with the addition of +// the ability to pass a context and additional request options. +// +// See ListTestRecommendations 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 *ResilienceHub) ListTestRecommendationsWithContext(ctx aws.Context, input *ListTestRecommendationsInput, opts ...request.Option) (*ListTestRecommendationsOutput, error) { + req, out := c.ListTestRecommendationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListTestRecommendationsPages iterates over the pages of a ListTestRecommendations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListTestRecommendations 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 ListTestRecommendations operation. +// pageNum := 0 +// err := client.ListTestRecommendationsPages(params, +// func(page *resiliencehub.ListTestRecommendationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListTestRecommendationsPages(input *ListTestRecommendationsInput, fn func(*ListTestRecommendationsOutput, bool) bool) error { + return c.ListTestRecommendationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListTestRecommendationsPagesWithContext same as ListTestRecommendationsPages 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 *ResilienceHub) ListTestRecommendationsPagesWithContext(ctx aws.Context, input *ListTestRecommendationsInput, fn func(*ListTestRecommendationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListTestRecommendationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListTestRecommendationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListTestRecommendationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListUnsupportedAppVersionResources = "ListUnsupportedAppVersionResources" + +// ListUnsupportedAppVersionResourcesRequest generates a "aws/request.Request" representing the +// client's request for the ListUnsupportedAppVersionResources 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 ListUnsupportedAppVersionResources for more information on using the ListUnsupportedAppVersionResources +// 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 ListUnsupportedAppVersionResourcesRequest method. +// req, resp := client.ListUnsupportedAppVersionResourcesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListUnsupportedAppVersionResources +func (c *ResilienceHub) ListUnsupportedAppVersionResourcesRequest(input *ListUnsupportedAppVersionResourcesInput) (req *request.Request, output *ListUnsupportedAppVersionResourcesOutput) { + op := &request.Operation{ + Name: opListUnsupportedAppVersionResources, + HTTPMethod: "POST", + HTTPPath: "/list-unsupported-app-version-resources", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListUnsupportedAppVersionResourcesInput{} + } + + output = &ListUnsupportedAppVersionResourcesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListUnsupportedAppVersionResources API operation for AWS Resilience Hub. +// +// Lists the resources that are not currently supported in AWS Resilience Hub. +// An unsupported resource is a resource that exists in the object that was +// used to create an app, but is not supported by Resilience Hub. +// +// 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 Resilience Hub's +// API operation ListUnsupportedAppVersionResources for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ListUnsupportedAppVersionResources +func (c *ResilienceHub) ListUnsupportedAppVersionResources(input *ListUnsupportedAppVersionResourcesInput) (*ListUnsupportedAppVersionResourcesOutput, error) { + req, out := c.ListUnsupportedAppVersionResourcesRequest(input) + return out, req.Send() +} + +// ListUnsupportedAppVersionResourcesWithContext is the same as ListUnsupportedAppVersionResources with the addition of +// the ability to pass a context and additional request options. +// +// See ListUnsupportedAppVersionResources 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 *ResilienceHub) ListUnsupportedAppVersionResourcesWithContext(ctx aws.Context, input *ListUnsupportedAppVersionResourcesInput, opts ...request.Option) (*ListUnsupportedAppVersionResourcesOutput, error) { + req, out := c.ListUnsupportedAppVersionResourcesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListUnsupportedAppVersionResourcesPages iterates over the pages of a ListUnsupportedAppVersionResources operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListUnsupportedAppVersionResources 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 ListUnsupportedAppVersionResources operation. +// pageNum := 0 +// err := client.ListUnsupportedAppVersionResourcesPages(params, +// func(page *resiliencehub.ListUnsupportedAppVersionResourcesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ResilienceHub) ListUnsupportedAppVersionResourcesPages(input *ListUnsupportedAppVersionResourcesInput, fn func(*ListUnsupportedAppVersionResourcesOutput, bool) bool) error { + return c.ListUnsupportedAppVersionResourcesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListUnsupportedAppVersionResourcesPagesWithContext same as ListUnsupportedAppVersionResourcesPages 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 *ResilienceHub) ListUnsupportedAppVersionResourcesPagesWithContext(ctx aws.Context, input *ListUnsupportedAppVersionResourcesInput, fn func(*ListUnsupportedAppVersionResourcesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListUnsupportedAppVersionResourcesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListUnsupportedAppVersionResourcesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListUnsupportedAppVersionResourcesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opPublishAppVersion = "PublishAppVersion" + +// PublishAppVersionRequest generates a "aws/request.Request" representing the +// client's request for the PublishAppVersion 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 PublishAppVersion for more information on using the PublishAppVersion +// 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 PublishAppVersionRequest method. +// req, resp := client.PublishAppVersionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/PublishAppVersion +func (c *ResilienceHub) PublishAppVersionRequest(input *PublishAppVersionInput) (req *request.Request, output *PublishAppVersionOutput) { + op := &request.Operation{ + Name: opPublishAppVersion, + HTTPMethod: "POST", + HTTPPath: "/publish-app-version", + } + + if input == nil { + input = &PublishAppVersionInput{} + } + + output = &PublishAppVersionOutput{} + req = c.newRequest(op, input, output) + return +} + +// PublishAppVersion API operation for AWS Resilience Hub. +// +// Publishes a new version of a specific Resilience Hub application. +// +// 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 Resilience Hub's +// API operation PublishAppVersion for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/PublishAppVersion +func (c *ResilienceHub) PublishAppVersion(input *PublishAppVersionInput) (*PublishAppVersionOutput, error) { + req, out := c.PublishAppVersionRequest(input) + return out, req.Send() +} + +// PublishAppVersionWithContext is the same as PublishAppVersion with the addition of +// the ability to pass a context and additional request options. +// +// See PublishAppVersion 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 *ResilienceHub) PublishAppVersionWithContext(ctx aws.Context, input *PublishAppVersionInput, opts ...request.Option) (*PublishAppVersionOutput, error) { + req, out := c.PublishAppVersionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opPutDraftAppVersionTemplate = "PutDraftAppVersionTemplate" + +// PutDraftAppVersionTemplateRequest generates a "aws/request.Request" representing the +// client's request for the PutDraftAppVersionTemplate 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 PutDraftAppVersionTemplate for more information on using the PutDraftAppVersionTemplate +// 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 PutDraftAppVersionTemplateRequest method. +// req, resp := client.PutDraftAppVersionTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/PutDraftAppVersionTemplate +func (c *ResilienceHub) PutDraftAppVersionTemplateRequest(input *PutDraftAppVersionTemplateInput) (req *request.Request, output *PutDraftAppVersionTemplateOutput) { + op := &request.Operation{ + Name: opPutDraftAppVersionTemplate, + HTTPMethod: "POST", + HTTPPath: "/put-draft-app-version-template", + } + + if input == nil { + input = &PutDraftAppVersionTemplateInput{} + } + + output = &PutDraftAppVersionTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// PutDraftAppVersionTemplate API operation for AWS Resilience Hub. +// +// Adds or updates the app template for a draft version of a Resilience Hub +// app. +// +// 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 Resilience Hub's +// API operation PutDraftAppVersionTemplate for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/PutDraftAppVersionTemplate +func (c *ResilienceHub) PutDraftAppVersionTemplate(input *PutDraftAppVersionTemplateInput) (*PutDraftAppVersionTemplateOutput, error) { + req, out := c.PutDraftAppVersionTemplateRequest(input) + return out, req.Send() +} + +// PutDraftAppVersionTemplateWithContext is the same as PutDraftAppVersionTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See PutDraftAppVersionTemplate 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 *ResilienceHub) PutDraftAppVersionTemplateWithContext(ctx aws.Context, input *PutDraftAppVersionTemplateInput, opts ...request.Option) (*PutDraftAppVersionTemplateOutput, error) { + req, out := c.PutDraftAppVersionTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRemoveDraftAppVersionResourceMappings = "RemoveDraftAppVersionResourceMappings" + +// RemoveDraftAppVersionResourceMappingsRequest generates a "aws/request.Request" representing the +// client's request for the RemoveDraftAppVersionResourceMappings 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 RemoveDraftAppVersionResourceMappings for more information on using the RemoveDraftAppVersionResourceMappings +// 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 RemoveDraftAppVersionResourceMappingsRequest method. +// req, resp := client.RemoveDraftAppVersionResourceMappingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/RemoveDraftAppVersionResourceMappings +func (c *ResilienceHub) RemoveDraftAppVersionResourceMappingsRequest(input *RemoveDraftAppVersionResourceMappingsInput) (req *request.Request, output *RemoveDraftAppVersionResourceMappingsOutput) { + op := &request.Operation{ + Name: opRemoveDraftAppVersionResourceMappings, + HTTPMethod: "POST", + HTTPPath: "/remove-draft-app-version-resource-mappings", + } + + if input == nil { + input = &RemoveDraftAppVersionResourceMappingsInput{} + } + + output = &RemoveDraftAppVersionResourceMappingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// RemoveDraftAppVersionResourceMappings API operation for AWS Resilience Hub. +// +// Removes resource mappings from a draft application version. +// +// 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 Resilience Hub's +// API operation RemoveDraftAppVersionResourceMappings for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/RemoveDraftAppVersionResourceMappings +func (c *ResilienceHub) RemoveDraftAppVersionResourceMappings(input *RemoveDraftAppVersionResourceMappingsInput) (*RemoveDraftAppVersionResourceMappingsOutput, error) { + req, out := c.RemoveDraftAppVersionResourceMappingsRequest(input) + return out, req.Send() +} + +// RemoveDraftAppVersionResourceMappingsWithContext is the same as RemoveDraftAppVersionResourceMappings with the addition of +// the ability to pass a context and additional request options. +// +// See RemoveDraftAppVersionResourceMappings 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 *ResilienceHub) RemoveDraftAppVersionResourceMappingsWithContext(ctx aws.Context, input *RemoveDraftAppVersionResourceMappingsInput, opts ...request.Option) (*RemoveDraftAppVersionResourceMappingsOutput, error) { + req, out := c.RemoveDraftAppVersionResourceMappingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opResolveAppVersionResources = "ResolveAppVersionResources" + +// ResolveAppVersionResourcesRequest generates a "aws/request.Request" representing the +// client's request for the ResolveAppVersionResources 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 ResolveAppVersionResources for more information on using the ResolveAppVersionResources +// 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 ResolveAppVersionResourcesRequest method. +// req, resp := client.ResolveAppVersionResourcesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ResolveAppVersionResources +func (c *ResilienceHub) ResolveAppVersionResourcesRequest(input *ResolveAppVersionResourcesInput) (req *request.Request, output *ResolveAppVersionResourcesOutput) { + op := &request.Operation{ + Name: opResolveAppVersionResources, + HTTPMethod: "POST", + HTTPPath: "/resolve-app-version-resources", + } + + if input == nil { + input = &ResolveAppVersionResourcesInput{} + } + + output = &ResolveAppVersionResourcesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ResolveAppVersionResources API operation for AWS Resilience Hub. +// +// Resolves the resources for an application version. +// +// 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 Resilience Hub's +// API operation ResolveAppVersionResources for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/ResolveAppVersionResources +func (c *ResilienceHub) ResolveAppVersionResources(input *ResolveAppVersionResourcesInput) (*ResolveAppVersionResourcesOutput, error) { + req, out := c.ResolveAppVersionResourcesRequest(input) + return out, req.Send() +} + +// ResolveAppVersionResourcesWithContext is the same as ResolveAppVersionResources with the addition of +// the ability to pass a context and additional request options. +// +// See ResolveAppVersionResources 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 *ResilienceHub) ResolveAppVersionResourcesWithContext(ctx aws.Context, input *ResolveAppVersionResourcesInput, opts ...request.Option) (*ResolveAppVersionResourcesOutput, error) { + req, out := c.ResolveAppVersionResourcesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartAppAssessment = "StartAppAssessment" + +// StartAppAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the StartAppAssessment 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 StartAppAssessment for more information on using the StartAppAssessment +// 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 StartAppAssessmentRequest method. +// req, resp := client.StartAppAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/StartAppAssessment +func (c *ResilienceHub) StartAppAssessmentRequest(input *StartAppAssessmentInput) (req *request.Request, output *StartAppAssessmentOutput) { + op := &request.Operation{ + Name: opStartAppAssessment, + HTTPMethod: "POST", + HTTPPath: "/start-app-assessment", + } + + if input == nil { + input = &StartAppAssessmentInput{} + } + + output = &StartAppAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartAppAssessment API operation for AWS Resilience Hub. +// +// Creates a new application assessment for an application. +// +// 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 Resilience Hub's +// API operation StartAppAssessment for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ServiceQuotaExceededException +// You have exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use Service Quotas to request a service +// quota increase. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/StartAppAssessment +func (c *ResilienceHub) StartAppAssessment(input *StartAppAssessmentInput) (*StartAppAssessmentOutput, error) { + req, out := c.StartAppAssessmentRequest(input) + return out, req.Send() +} + +// StartAppAssessmentWithContext is the same as StartAppAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See StartAppAssessment 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 *ResilienceHub) StartAppAssessmentWithContext(ctx aws.Context, input *StartAppAssessmentInput, opts ...request.Option) (*StartAppAssessmentOutput, error) { + req, out := c.StartAppAssessmentRequest(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/resiliencehub-2020-04-30/TagResource +func (c *ResilienceHub) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", + } + + 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 Resilience Hub. +// +// Applies one or more tags to a 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 Resilience Hub's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/TagResource +func (c *ResilienceHub) 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 *ResilienceHub) 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/resiliencehub-2020-04-30/UntagResource +func (c *ResilienceHub) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", + } + + 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 Resilience Hub. +// +// Removes one or more tags from a 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 Resilience Hub's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UntagResource +func (c *ResilienceHub) 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 *ResilienceHub) 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 opUpdateApp = "UpdateApp" + +// UpdateAppRequest generates a "aws/request.Request" representing the +// client's request for the UpdateApp 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 UpdateApp for more information on using the UpdateApp +// 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 UpdateAppRequest method. +// req, resp := client.UpdateAppRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateApp +func (c *ResilienceHub) UpdateAppRequest(input *UpdateAppInput) (req *request.Request, output *UpdateAppOutput) { + op := &request.Operation{ + Name: opUpdateApp, + HTTPMethod: "POST", + HTTPPath: "/update-app", + } + + if input == nil { + input = &UpdateAppInput{} + } + + output = &UpdateAppOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateApp API operation for AWS Resilience Hub. +// +// Updates an application. +// +// 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 Resilience Hub's +// API operation UpdateApp for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateApp +func (c *ResilienceHub) UpdateApp(input *UpdateAppInput) (*UpdateAppOutput, error) { + req, out := c.UpdateAppRequest(input) + return out, req.Send() +} + +// UpdateAppWithContext is the same as UpdateApp with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateApp 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 *ResilienceHub) UpdateAppWithContext(ctx aws.Context, input *UpdateAppInput, opts ...request.Option) (*UpdateAppOutput, error) { + req, out := c.UpdateAppRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateResiliencyPolicy = "UpdateResiliencyPolicy" + +// UpdateResiliencyPolicyRequest generates a "aws/request.Request" representing the +// client's request for the UpdateResiliencyPolicy 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 UpdateResiliencyPolicy for more information on using the UpdateResiliencyPolicy +// 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 UpdateResiliencyPolicyRequest method. +// req, resp := client.UpdateResiliencyPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateResiliencyPolicy +func (c *ResilienceHub) UpdateResiliencyPolicyRequest(input *UpdateResiliencyPolicyInput) (req *request.Request, output *UpdateResiliencyPolicyOutput) { + op := &request.Operation{ + Name: opUpdateResiliencyPolicy, + HTTPMethod: "POST", + HTTPPath: "/update-resiliency-policy", + } + + if input == nil { + input = &UpdateResiliencyPolicyInput{} + } + + output = &UpdateResiliencyPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateResiliencyPolicy API operation for AWS Resilience Hub. +// +// Updates a resiliency policy. +// +// 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 Resilience Hub's +// API operation UpdateResiliencyPolicy for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +// +// * ResourceNotFoundException +// The specified resource could not be found. +// +// * ConflictException +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +// +// * ThrottlingException +// The limit on the number of requests per second was exceeded. +// +// * ValidationException +// Indicates that a request was not valid. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30/UpdateResiliencyPolicy +func (c *ResilienceHub) UpdateResiliencyPolicy(input *UpdateResiliencyPolicyInput) (*UpdateResiliencyPolicyOutput, error) { + req, out := c.UpdateResiliencyPolicyRequest(input) + return out, req.Send() +} + +// UpdateResiliencyPolicyWithContext is the same as UpdateResiliencyPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateResiliencyPolicy 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 *ResilienceHub) UpdateResiliencyPolicyWithContext(ctx aws.Context, input *UpdateResiliencyPolicyInput, opts ...request.Option) (*UpdateResiliencyPolicyOutput, error) { + req, out := c.UpdateResiliencyPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 +} + +type AddDraftAppVersionResourceMappingsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // Mappings used to map logical resources from the template to physical resources. + // You can use the mapping type CFN_STACK if the application template uses a + // logical stack name. Or you can map individual resources by using the mapping + // type RESOURCE. We recommend using the mapping type CFN_STACK if the application + // is backed by a CloudFormation stack. + // + // ResourceMappings is a required field + ResourceMappings []*ResourceMapping `locationName:"resourceMappings" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AddDraftAppVersionResourceMappingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AddDraftAppVersionResourceMappingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AddDraftAppVersionResourceMappingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AddDraftAppVersionResourceMappingsInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.ResourceMappings == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceMappings")) + } + if s.ResourceMappings != nil { + for i, v := range s.ResourceMappings { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ResourceMappings", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *AddDraftAppVersionResourceMappingsInput) SetAppArn(v string) *AddDraftAppVersionResourceMappingsInput { + s.AppArn = &v + return s +} + +// SetResourceMappings sets the ResourceMappings field's value. +func (s *AddDraftAppVersionResourceMappingsInput) SetResourceMappings(v []*ResourceMapping) *AddDraftAppVersionResourceMappingsInput { + s.ResourceMappings = v + return s +} + +type AddDraftAppVersionResourceMappingsOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // Mappings used to map logical resources from the template to physical resources. + // You can use the mapping type CFN_STACK if the application template uses a + // logical stack name. Or you can map individual resources by using the mapping + // type RESOURCE. We recommend using the mapping type CFN_STACK if the application + // is backed by a CloudFormation stack. + // + // ResourceMappings is a required field + ResourceMappings []*ResourceMapping `locationName:"resourceMappings" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AddDraftAppVersionResourceMappingsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AddDraftAppVersionResourceMappingsOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *AddDraftAppVersionResourceMappingsOutput) SetAppArn(v string) *AddDraftAppVersionResourceMappingsOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *AddDraftAppVersionResourceMappingsOutput) SetAppVersion(v string) *AddDraftAppVersionResourceMappingsOutput { + s.AppVersion = &v + return s +} + +// SetResourceMappings sets the ResourceMappings field's value. +func (s *AddDraftAppVersionResourceMappingsOutput) SetResourceMappings(v []*ResourceMapping) *AddDraftAppVersionResourceMappingsOutput { + s.ResourceMappings = v + return s +} + +// Defines a recommendation for a CloudWatch alarm. +type AlarmRecommendation struct { + _ struct{} `type:"structure"` + + // The application component for the CloudWatch alarm recommendation. + AppComponentName *string `locationName:"appComponentName" type:"string"` + + // The description of the recommendation. + Description *string `locationName:"description" type:"string"` + + // The list of CloudWatch alarm recommendations. + Items []*RecommendationItem `locationName:"items" type:"list"` + + // The name of the alarm recommendation. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The prerequisite for the alarm recommendation. + Prerequisite *string `locationName:"prerequisite" min:"1" type:"string"` + + // The identifier of the alarm recommendation. + // + // RecommendationId is a required field + RecommendationId *string `locationName:"recommendationId" type:"string" required:"true"` + + // The reference identifier of the alarm recommendation. + // + // ReferenceId is a required field + ReferenceId *string `locationName:"referenceId" min:"1" type:"string" required:"true"` + + // The type of alarm recommendation. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"AlarmType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AlarmRecommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AlarmRecommendation) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *AlarmRecommendation) SetAppComponentName(v string) *AlarmRecommendation { + s.AppComponentName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AlarmRecommendation) SetDescription(v string) *AlarmRecommendation { + s.Description = &v + return s +} + +// SetItems sets the Items field's value. +func (s *AlarmRecommendation) SetItems(v []*RecommendationItem) *AlarmRecommendation { + s.Items = v + return s +} + +// SetName sets the Name field's value. +func (s *AlarmRecommendation) SetName(v string) *AlarmRecommendation { + s.Name = &v + return s +} + +// SetPrerequisite sets the Prerequisite field's value. +func (s *AlarmRecommendation) SetPrerequisite(v string) *AlarmRecommendation { + s.Prerequisite = &v + return s +} + +// SetRecommendationId sets the RecommendationId field's value. +func (s *AlarmRecommendation) SetRecommendationId(v string) *AlarmRecommendation { + s.RecommendationId = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *AlarmRecommendation) SetReferenceId(v string) *AlarmRecommendation { + s.ReferenceId = &v + return s +} + +// SetType sets the Type field's value. +func (s *AlarmRecommendation) SetType(v string) *AlarmRecommendation { + s.Type = &v + return s +} + +// Defines a Resilience Hub application. +type App struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The current status of compliance for the resiliency policy. + ComplianceStatus *string `locationName:"complianceStatus" type:"string" enum:"AppComplianceStatusType"` + + // The timestamp for when the app was created. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" required:"true"` + + // The optional description for an app. + Description *string `locationName:"description" type:"string"` + + // The timestamp for the most recent compliance evaluation. + LastAppComplianceEvaluationTime *time.Time `locationName:"lastAppComplianceEvaluationTime" type:"timestamp"` + + // The timestamp for the most recent resiliency score evaluation. + LastResiliencyScoreEvaluationTime *time.Time `locationName:"lastResiliencyScoreEvaluationTime" type:"timestamp"` + + // The name for the application. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + PolicyArn *string `locationName:"policyArn" type:"string"` + + // The current resiliency score for the application. + ResiliencyScore *float64 `locationName:"resiliencyScore" type:"double"` + + // The status of the action. + Status *string `locationName:"status" type:"string" enum:"AppStatusType"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by App's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s App) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s App) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *App) SetAppArn(v string) *App { + s.AppArn = &v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *App) SetComplianceStatus(v string) *App { + s.ComplianceStatus = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *App) SetCreationTime(v time.Time) *App { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *App) SetDescription(v string) *App { + s.Description = &v + return s +} + +// SetLastAppComplianceEvaluationTime sets the LastAppComplianceEvaluationTime field's value. +func (s *App) SetLastAppComplianceEvaluationTime(v time.Time) *App { + s.LastAppComplianceEvaluationTime = &v + return s +} + +// SetLastResiliencyScoreEvaluationTime sets the LastResiliencyScoreEvaluationTime field's value. +func (s *App) SetLastResiliencyScoreEvaluationTime(v time.Time) *App { + s.LastResiliencyScoreEvaluationTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *App) SetName(v string) *App { + s.Name = &v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *App) SetPolicyArn(v string) *App { + s.PolicyArn = &v + return s +} + +// SetResiliencyScore sets the ResiliencyScore field's value. +func (s *App) SetResiliencyScore(v float64) *App { + s.ResiliencyScore = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *App) SetStatus(v string) *App { + s.Status = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *App) SetTags(v map[string]*string) *App { + s.Tags = v + return s +} + +// Defines an application assessment. +type AppAssessment struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `locationName:"appArn" type:"string"` + + // The version of the application. + AppVersion *string `locationName:"appVersion" type:"string"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The name of the assessment. + AssessmentName *string `locationName:"assessmentName" type:"string"` + + // The current status of the assessment for the resiliency policy. + // + // AssessmentStatus is a required field + AssessmentStatus *string `locationName:"assessmentStatus" type:"string" required:"true" enum:"AssessmentStatus"` + + // The application compliance against the resiliency policy. + Compliance map[string]*DisruptionCompliance `locationName:"compliance" type:"map"` + + // The current status of the compliance for the resiliency policy. + ComplianceStatus *string `locationName:"complianceStatus" type:"string" enum:"ComplianceStatus"` + + // The cost for the application. + Cost *Cost `locationName:"cost" type:"structure"` + + // The end time for the action. + EndTime *time.Time `locationName:"endTime" type:"timestamp"` + + // The entity that invoked the assessment. + // + // Invoker is a required field + Invoker *string `locationName:"invoker" type:"string" required:"true" enum:"AssessmentInvoker"` + + // Error or warning message from the assessment execution + Message *string `locationName:"message" min:"1" type:"string"` + + // The resiliency policy. + Policy *ResiliencyPolicy `locationName:"policy" type:"structure"` + + // The current resiliency score for the application. + ResiliencyScore *ResiliencyScore `locationName:"resiliencyScore" type:"structure"` + + // The starting time for the action. + StartTime *time.Time `locationName:"startTime" type:"timestamp"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AppAssessment's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppAssessment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppAssessment) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *AppAssessment) SetAppArn(v string) *AppAssessment { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *AppAssessment) SetAppVersion(v string) *AppAssessment { + s.AppVersion = &v + return s +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *AppAssessment) SetAssessmentArn(v string) *AppAssessment { + s.AssessmentArn = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *AppAssessment) SetAssessmentName(v string) *AppAssessment { + s.AssessmentName = &v + return s +} + +// SetAssessmentStatus sets the AssessmentStatus field's value. +func (s *AppAssessment) SetAssessmentStatus(v string) *AppAssessment { + s.AssessmentStatus = &v + return s +} + +// SetCompliance sets the Compliance field's value. +func (s *AppAssessment) SetCompliance(v map[string]*DisruptionCompliance) *AppAssessment { + s.Compliance = v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *AppAssessment) SetComplianceStatus(v string) *AppAssessment { + s.ComplianceStatus = &v + return s +} + +// SetCost sets the Cost field's value. +func (s *AppAssessment) SetCost(v *Cost) *AppAssessment { + s.Cost = v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *AppAssessment) SetEndTime(v time.Time) *AppAssessment { + s.EndTime = &v + return s +} + +// SetInvoker sets the Invoker field's value. +func (s *AppAssessment) SetInvoker(v string) *AppAssessment { + s.Invoker = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *AppAssessment) SetMessage(v string) *AppAssessment { + s.Message = &v + return s +} + +// SetPolicy sets the Policy field's value. +func (s *AppAssessment) SetPolicy(v *ResiliencyPolicy) *AppAssessment { + s.Policy = v + return s +} + +// SetResiliencyScore sets the ResiliencyScore field's value. +func (s *AppAssessment) SetResiliencyScore(v *ResiliencyScore) *AppAssessment { + s.ResiliencyScore = v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *AppAssessment) SetStartTime(v time.Time) *AppAssessment { + s.StartTime = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *AppAssessment) SetTags(v map[string]*string) *AppAssessment { + s.Tags = v + return s +} + +// Defines an application assessment summary. +type AppAssessmentSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `locationName:"appArn" type:"string"` + + // The version of the application. + AppVersion *string `locationName:"appVersion" type:"string"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The name of the assessment. + AssessmentName *string `locationName:"assessmentName" type:"string"` + + // The current status of the assessment for the resiliency policy. + // + // AssessmentStatus is a required field + AssessmentStatus *string `locationName:"assessmentStatus" type:"string" required:"true" enum:"AssessmentStatus"` + + // The current status of compliance for the resiliency policy. + ComplianceStatus *string `locationName:"complianceStatus" type:"string" enum:"ComplianceStatus"` + + // The cost for the application. + Cost *Cost `locationName:"cost" type:"structure"` + + // The end time for the action. + EndTime *time.Time `locationName:"endTime" type:"timestamp"` + + // The entity that invoked the assessment. + Invoker *string `locationName:"invoker" type:"string" enum:"AssessmentInvoker"` + + // The message from the assessment run. + Message *string `locationName:"message" min:"1" type:"string"` + + // The current resiliency score for the application. + ResiliencyScore *float64 `locationName:"resiliencyScore" type:"double"` + + // The starting time for the action. + StartTime *time.Time `locationName:"startTime" type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppAssessmentSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppAssessmentSummary) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *AppAssessmentSummary) SetAppArn(v string) *AppAssessmentSummary { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *AppAssessmentSummary) SetAppVersion(v string) *AppAssessmentSummary { + s.AppVersion = &v + return s +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *AppAssessmentSummary) SetAssessmentArn(v string) *AppAssessmentSummary { + s.AssessmentArn = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *AppAssessmentSummary) SetAssessmentName(v string) *AppAssessmentSummary { + s.AssessmentName = &v + return s +} + +// SetAssessmentStatus sets the AssessmentStatus field's value. +func (s *AppAssessmentSummary) SetAssessmentStatus(v string) *AppAssessmentSummary { + s.AssessmentStatus = &v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *AppAssessmentSummary) SetComplianceStatus(v string) *AppAssessmentSummary { + s.ComplianceStatus = &v + return s +} + +// SetCost sets the Cost field's value. +func (s *AppAssessmentSummary) SetCost(v *Cost) *AppAssessmentSummary { + s.Cost = v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *AppAssessmentSummary) SetEndTime(v time.Time) *AppAssessmentSummary { + s.EndTime = &v + return s +} + +// SetInvoker sets the Invoker field's value. +func (s *AppAssessmentSummary) SetInvoker(v string) *AppAssessmentSummary { + s.Invoker = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *AppAssessmentSummary) SetMessage(v string) *AppAssessmentSummary { + s.Message = &v + return s +} + +// SetResiliencyScore sets the ResiliencyScore field's value. +func (s *AppAssessmentSummary) SetResiliencyScore(v float64) *AppAssessmentSummary { + s.ResiliencyScore = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *AppAssessmentSummary) SetStartTime(v time.Time) *AppAssessmentSummary { + s.StartTime = &v + return s +} + +// Defines an application component. +type AppComponent struct { + _ struct{} `type:"structure"` + + // The name of the application component. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The type of application component. + // + // Type is a required field + Type *string `locationName:"type" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppComponent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppComponent) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *AppComponent) SetName(v string) *AppComponent { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *AppComponent) SetType(v string) *AppComponent { + s.Type = &v + return s +} + +// Defines the compliance of an application component against the resiliency +// policy. +type AppComponentCompliance struct { + _ struct{} `type:"structure"` + + // The name of the application component. + AppComponentName *string `locationName:"appComponentName" type:"string"` + + // The compliance of the application component against the resiliency policy. + Compliance map[string]*DisruptionCompliance `locationName:"compliance" type:"map"` + + // The cost for the application. + Cost *Cost `locationName:"cost" type:"structure"` + + // The compliance message. + Message *string `locationName:"message" min:"1" type:"string"` + + // The current resiliency score for the application. + ResiliencyScore *ResiliencyScore `locationName:"resiliencyScore" type:"structure"` + + // The status of the action. + Status *string `locationName:"status" type:"string" enum:"ComplianceStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppComponentCompliance) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppComponentCompliance) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *AppComponentCompliance) SetAppComponentName(v string) *AppComponentCompliance { + s.AppComponentName = &v + return s +} + +// SetCompliance sets the Compliance field's value. +func (s *AppComponentCompliance) SetCompliance(v map[string]*DisruptionCompliance) *AppComponentCompliance { + s.Compliance = v + return s +} + +// SetCost sets the Cost field's value. +func (s *AppComponentCompliance) SetCost(v *Cost) *AppComponentCompliance { + s.Cost = v + return s +} + +// SetMessage sets the Message field's value. +func (s *AppComponentCompliance) SetMessage(v string) *AppComponentCompliance { + s.Message = &v + return s +} + +// SetResiliencyScore sets the ResiliencyScore field's value. +func (s *AppComponentCompliance) SetResiliencyScore(v *ResiliencyScore) *AppComponentCompliance { + s.ResiliencyScore = v + return s +} + +// SetStatus sets the Status field's value. +func (s *AppComponentCompliance) SetStatus(v string) *AppComponentCompliance { + s.Status = &v + return s +} + +// Defines an application summary. +type AppSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The current status of compliance for the resiliency policy. + ComplianceStatus *string `locationName:"complianceStatus" type:"string" enum:"AppComplianceStatusType"` + + // The timestamp for when the app was created. + // + // CreationTime is a required field + CreationTime *time.Time `locationName:"creationTime" type:"timestamp" required:"true"` + + // The optional description for an app. + Description *string `locationName:"description" type:"string"` + + // The name of the application. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The current resiliency score for the application. + ResiliencyScore *float64 `locationName:"resiliencyScore" type:"double"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppSummary) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *AppSummary) SetAppArn(v string) *AppSummary { + s.AppArn = &v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *AppSummary) SetComplianceStatus(v string) *AppSummary { + s.ComplianceStatus = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AppSummary) SetCreationTime(v time.Time) *AppSummary { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AppSummary) SetDescription(v string) *AppSummary { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *AppSummary) SetName(v string) *AppSummary { + s.Name = &v + return s +} + +// SetResiliencyScore sets the ResiliencyScore field's value. +func (s *AppSummary) SetResiliencyScore(v float64) *AppSummary { + s.ResiliencyScore = &v + return s +} + +// The version of the application. +type AppVersionSummary struct { + _ struct{} `type:"structure"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppVersionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppVersionSummary) GoString() string { + return s.String() +} + +// SetAppVersion sets the AppVersion field's value. +func (s *AppVersionSummary) SetAppVersion(v string) *AppVersionSummary { + s.AppVersion = &v + return s +} + +// Defines recommendations for a Resilience Hub application component, returned +// as an object. This object contains component names, configuration recommendations, +// and recommendation statuses. +type ComponentRecommendation struct { + _ struct{} `type:"structure"` + + // The name of the application component. + // + // AppComponentName is a required field + AppComponentName *string `locationName:"appComponentName" type:"string" required:"true"` + + // The list of recommendations. + // + // ConfigRecommendations is a required field + ConfigRecommendations []*ConfigRecommendation `locationName:"configRecommendations" type:"list" required:"true"` + + // The recommendation status. + // + // RecommendationStatus is a required field + RecommendationStatus *string `locationName:"recommendationStatus" type:"string" required:"true" enum:"RecommendationComplianceStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ComponentRecommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ComponentRecommendation) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *ComponentRecommendation) SetAppComponentName(v string) *ComponentRecommendation { + s.AppComponentName = &v + return s +} + +// SetConfigRecommendations sets the ConfigRecommendations field's value. +func (s *ComponentRecommendation) SetConfigRecommendations(v []*ConfigRecommendation) *ComponentRecommendation { + s.ConfigRecommendations = v + return s +} + +// SetRecommendationStatus sets the RecommendationStatus field's value. +func (s *ComponentRecommendation) SetRecommendationStatus(v string) *ComponentRecommendation { + s.RecommendationStatus = &v + return s +} + +// Defines a configuration recommendation. +type ConfigRecommendation struct { + _ struct{} `type:"structure"` + + // The application component name. + AppComponentName *string `locationName:"appComponentName" type:"string"` + + // The current compliance against the resiliency policy before applying the + // configuration change. + Compliance map[string]*DisruptionCompliance `locationName:"compliance" type:"map"` + + // The cost for the application. + Cost *Cost `locationName:"cost" type:"structure"` + + // The optional description for an app. + Description *string `locationName:"description" type:"string"` + + // The architecture type. + HaArchitecture *string `locationName:"haArchitecture" type:"string" enum:"HaArchitecture"` + + // The name of the recommendation configuration. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The type of optimization. + // + // OptimizationType is a required field + OptimizationType *string `locationName:"optimizationType" type:"string" required:"true" enum:"ConfigRecommendationOptimizationType"` + + // The expected compliance against the resiliency policy after applying the + // configuration change. + RecommendationCompliance map[string]*RecommendationDisruptionCompliance `locationName:"recommendationCompliance" type:"map"` + + // The reference identifier for the recommendation configuration. + // + // ReferenceId is a required field + ReferenceId *string `locationName:"referenceId" min:"1" type:"string" required:"true"` + + // List of the suggested configuration changes. + SuggestedChanges []*string `locationName:"suggestedChanges" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfigRecommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConfigRecommendation) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *ConfigRecommendation) SetAppComponentName(v string) *ConfigRecommendation { + s.AppComponentName = &v + return s +} + +// SetCompliance sets the Compliance field's value. +func (s *ConfigRecommendation) SetCompliance(v map[string]*DisruptionCompliance) *ConfigRecommendation { + s.Compliance = v + return s +} + +// SetCost sets the Cost field's value. +func (s *ConfigRecommendation) SetCost(v *Cost) *ConfigRecommendation { + s.Cost = v + return s +} + +// SetDescription sets the Description field's value. +func (s *ConfigRecommendation) SetDescription(v string) *ConfigRecommendation { + s.Description = &v + return s +} + +// SetHaArchitecture sets the HaArchitecture field's value. +func (s *ConfigRecommendation) SetHaArchitecture(v string) *ConfigRecommendation { + s.HaArchitecture = &v + return s +} + +// SetName sets the Name field's value. +func (s *ConfigRecommendation) SetName(v string) *ConfigRecommendation { + s.Name = &v + return s +} + +// SetOptimizationType sets the OptimizationType field's value. +func (s *ConfigRecommendation) SetOptimizationType(v string) *ConfigRecommendation { + s.OptimizationType = &v + return s +} + +// SetRecommendationCompliance sets the RecommendationCompliance field's value. +func (s *ConfigRecommendation) SetRecommendationCompliance(v map[string]*RecommendationDisruptionCompliance) *ConfigRecommendation { + s.RecommendationCompliance = v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *ConfigRecommendation) SetReferenceId(v string) *ConfigRecommendation { + s.ReferenceId = &v + return s +} + +// SetSuggestedChanges sets the SuggestedChanges field's value. +func (s *ConfigRecommendation) SetSuggestedChanges(v []*string) *ConfigRecommendation { + s.SuggestedChanges = v + return s +} + +// Occurs when a conflict with a previous successful write is detected. This +// generally occurs when the previous write did not have time to propagate to +// the host serving the current request. A retry (with appropriate backoff logic) +// is the recommended response to this exception. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` + + // The identifier of the resource that the exception applies to. + ResourceId *string `locationName:"resourceId" type:"string"` + + // The type of the resource that the exception applies to. + ResourceType *string `locationName:"resourceType" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 +} + +// Defines a cost object. +type Cost struct { + _ struct{} `type:"structure"` + + // The cost amount. + // + // Amount is a required field + Amount *float64 `locationName:"amount" type:"double" required:"true"` + + // The cost currency, for example USD. + // + // Currency is a required field + Currency *string `locationName:"currency" type:"string" required:"true"` + + // The cost frequency. + // + // Frequency is a required field + Frequency *string `locationName:"frequency" type:"string" required:"true" enum:"CostFrequency"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Cost) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Cost) GoString() string { + return s.String() +} + +// SetAmount sets the Amount field's value. +func (s *Cost) SetAmount(v float64) *Cost { + s.Amount = &v + return s +} + +// SetCurrency sets the Currency field's value. +func (s *Cost) SetCurrency(v string) *Cost { + s.Currency = &v + return s +} + +// SetFrequency sets the Frequency field's value. +func (s *Cost) SetFrequency(v string) *Cost { + s.Frequency = &v + return s +} + +type CreateAppInput struct { + _ struct{} `type:"structure"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The optional description for an app. + Description *string `locationName:"description" type:"string"` + + // The name for the application. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + PolicyArn *string `locationName:"policyArn" type:"string"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateAppInput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAppInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAppInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAppInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAppInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateAppInput) SetClientToken(v string) *CreateAppInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateAppInput) SetDescription(v string) *CreateAppInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAppInput) SetName(v string) *CreateAppInput { + s.Name = &v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *CreateAppInput) SetPolicyArn(v string) *CreateAppInput { + s.PolicyArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateAppInput) SetTags(v map[string]*string) *CreateAppInput { + s.Tags = v + return s +} + +type CreateAppOutput struct { + _ struct{} `type:"structure"` + + // The created application returned as an object with details including compliance + // status, creation time, description, resiliency score, and more. + // + // App is a required field + App *App `locationName:"app" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAppOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateAppOutput) GoString() string { + return s.String() +} + +// SetApp sets the App field's value. +func (s *CreateAppOutput) SetApp(v *App) *CreateAppOutput { + s.App = v + return s +} + +type CreateRecommendationTemplateInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The name of the Amazon S3 bucket that will contain the recommendation template. + BucketName *string `locationName:"bucketName" type:"string"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The format for the recommendation template. + // + // CfnJson + // + // The template is CloudFormation JSON. + // + // CfnYaml + // + // The template is CloudFormation YAML. + Format *string `locationName:"format" type:"string" enum:"TemplateFormat"` + + // The name for the recommendation template. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // Identifiers for the recommendations used to create a recommendation template. + RecommendationIds []*string `locationName:"recommendationIds" min:"1" type:"list"` + + // An array of strings that specify the recommendation template type or types. + // + // Alarm + // + // The template is an AlarmRecommendation template. + // + // Sop + // + // The template is a SopRecommendation template. + // + // Test + // + // The template is a TestRecommendation template. + RecommendationTypes []*string `locationName:"recommendationTypes" min:"1" type:"list"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateRecommendationTemplateInput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommendationTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommendationTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRecommendationTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRecommendationTemplateInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.RecommendationIds != nil && len(s.RecommendationIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RecommendationIds", 1)) + } + if s.RecommendationTypes != nil && len(s.RecommendationTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RecommendationTypes", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *CreateRecommendationTemplateInput) SetAssessmentArn(v string) *CreateRecommendationTemplateInput { + s.AssessmentArn = &v + return s +} + +// SetBucketName sets the BucketName field's value. +func (s *CreateRecommendationTemplateInput) SetBucketName(v string) *CreateRecommendationTemplateInput { + s.BucketName = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateRecommendationTemplateInput) SetClientToken(v string) *CreateRecommendationTemplateInput { + s.ClientToken = &v + return s +} + +// SetFormat sets the Format field's value. +func (s *CreateRecommendationTemplateInput) SetFormat(v string) *CreateRecommendationTemplateInput { + s.Format = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRecommendationTemplateInput) SetName(v string) *CreateRecommendationTemplateInput { + s.Name = &v + return s +} + +// SetRecommendationIds sets the RecommendationIds field's value. +func (s *CreateRecommendationTemplateInput) SetRecommendationIds(v []*string) *CreateRecommendationTemplateInput { + s.RecommendationIds = v + return s +} + +// SetRecommendationTypes sets the RecommendationTypes field's value. +func (s *CreateRecommendationTemplateInput) SetRecommendationTypes(v []*string) *CreateRecommendationTemplateInput { + s.RecommendationTypes = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRecommendationTemplateInput) SetTags(v map[string]*string) *CreateRecommendationTemplateInput { + s.Tags = v + return s +} + +type CreateRecommendationTemplateOutput struct { + _ struct{} `type:"structure"` + + // The newly created recommendation template, returned as an object. This object + // includes the template's name, format, status, tags, Amazon S3 bucket location, + // and more. + RecommendationTemplate *RecommendationTemplate `locationName:"recommendationTemplate" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommendationTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommendationTemplateOutput) GoString() string { + return s.String() +} + +// SetRecommendationTemplate sets the RecommendationTemplate field's value. +func (s *CreateRecommendationTemplateOutput) SetRecommendationTemplate(v *RecommendationTemplate) *CreateRecommendationTemplateOutput { + s.RecommendationTemplate = v + return s +} + +type CreateResiliencyPolicyInput struct { + _ struct{} `type:"structure"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // Specifies a high-level geographical location constraint for where your resilience + // policy data can be stored. + DataLocationConstraint *string `locationName:"dataLocationConstraint" type:"string" enum:"DataLocationConstraint"` + + // The type of resiliency policy to be created, including the recovery time + // objective (RTO) and recovery point objective (RPO) in seconds. + // + // Policy is a required field + Policy map[string]*FailurePolicy `locationName:"policy" type:"map" required:"true"` + + // The description for the policy. + PolicyDescription *string `locationName:"policyDescription" type:"string"` + + // The name of the policy + // + // PolicyName is a required field + PolicyName *string `locationName:"policyName" type:"string" required:"true"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateResiliencyPolicyInput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` + + // The tier for this resiliency policy, ranging from the highest severity (MissionCritical) + // to lowest (NonCritical). + // + // Tier is a required field + Tier *string `locationName:"tier" type:"string" required:"true" enum:"ResiliencyPolicyTier"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateResiliencyPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateResiliencyPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateResiliencyPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateResiliencyPolicyInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Policy == nil { + invalidParams.Add(request.NewErrParamRequired("Policy")) + } + if s.PolicyName == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyName")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tier == nil { + invalidParams.Add(request.NewErrParamRequired("Tier")) + } + if s.Policy != nil { + for i, v := range s.Policy { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Policy", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateResiliencyPolicyInput) SetClientToken(v string) *CreateResiliencyPolicyInput { + s.ClientToken = &v + return s +} + +// SetDataLocationConstraint sets the DataLocationConstraint field's value. +func (s *CreateResiliencyPolicyInput) SetDataLocationConstraint(v string) *CreateResiliencyPolicyInput { + s.DataLocationConstraint = &v + return s +} + +// SetPolicy sets the Policy field's value. +func (s *CreateResiliencyPolicyInput) SetPolicy(v map[string]*FailurePolicy) *CreateResiliencyPolicyInput { + s.Policy = v + return s +} + +// SetPolicyDescription sets the PolicyDescription field's value. +func (s *CreateResiliencyPolicyInput) SetPolicyDescription(v string) *CreateResiliencyPolicyInput { + s.PolicyDescription = &v + return s +} + +// SetPolicyName sets the PolicyName field's value. +func (s *CreateResiliencyPolicyInput) SetPolicyName(v string) *CreateResiliencyPolicyInput { + s.PolicyName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateResiliencyPolicyInput) SetTags(v map[string]*string) *CreateResiliencyPolicyInput { + s.Tags = v + return s +} + +// SetTier sets the Tier field's value. +func (s *CreateResiliencyPolicyInput) SetTier(v string) *CreateResiliencyPolicyInput { + s.Tier = &v + return s +} + +type CreateResiliencyPolicyOutput struct { + _ struct{} `type:"structure"` + + // The type of resiliency policy that was created, including the recovery time + // objective (RTO) and recovery point objective (RPO) in seconds. + // + // Policy is a required field + Policy *ResiliencyPolicy `locationName:"policy" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateResiliencyPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateResiliencyPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicy sets the Policy field's value. +func (s *CreateResiliencyPolicyOutput) SetPolicy(v *ResiliencyPolicy) *CreateResiliencyPolicyOutput { + s.Policy = v + return s +} + +type DeleteAppAssessmentInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAppAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAppAssessmentInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *DeleteAppAssessmentInput) SetAssessmentArn(v string) *DeleteAppAssessmentInput { + s.AssessmentArn = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *DeleteAppAssessmentInput) SetClientToken(v string) *DeleteAppAssessmentInput { + s.ClientToken = &v + return s +} + +type DeleteAppAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The current status of the assessment for the resiliency policy. + // + // AssessmentStatus is a required field + AssessmentStatus *string `locationName:"assessmentStatus" type:"string" required:"true" enum:"AssessmentStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *DeleteAppAssessmentOutput) SetAssessmentArn(v string) *DeleteAppAssessmentOutput { + s.AssessmentArn = &v + return s +} + +// SetAssessmentStatus sets the AssessmentStatus field's value. +func (s *DeleteAppAssessmentOutput) SetAssessmentStatus(v string) *DeleteAppAssessmentOutput { + s.AssessmentStatus = &v + return s +} + +type DeleteAppInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // A boolean option to force the deletion of a Resilience Hub application. + ForceDelete *bool `locationName:"forceDelete" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAppInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAppInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *DeleteAppInput) SetAppArn(v string) *DeleteAppInput { + s.AppArn = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *DeleteAppInput) SetClientToken(v string) *DeleteAppInput { + s.ClientToken = &v + return s +} + +// SetForceDelete sets the ForceDelete field's value. +func (s *DeleteAppInput) SetForceDelete(v bool) *DeleteAppInput { + s.ForceDelete = &v + return s +} + +type DeleteAppOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteAppOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *DeleteAppOutput) SetAppArn(v string) *DeleteAppOutput { + s.AppArn = &v + return s +} + +type DeleteRecommendationTemplateInput struct { + _ struct{} `type:"structure"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The Amazon Resource Name (ARN) for a recommendation template. + // + // RecommendationTemplateArn is a required field + RecommendationTemplateArn *string `locationName:"recommendationTemplateArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommendationTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommendationTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRecommendationTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRecommendationTemplateInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.RecommendationTemplateArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecommendationTemplateArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *DeleteRecommendationTemplateInput) SetClientToken(v string) *DeleteRecommendationTemplateInput { + s.ClientToken = &v + return s +} + +// SetRecommendationTemplateArn sets the RecommendationTemplateArn field's value. +func (s *DeleteRecommendationTemplateInput) SetRecommendationTemplateArn(v string) *DeleteRecommendationTemplateInput { + s.RecommendationTemplateArn = &v + return s +} + +type DeleteRecommendationTemplateOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for a recommendation template. + // + // RecommendationTemplateArn is a required field + RecommendationTemplateArn *string `locationName:"recommendationTemplateArn" type:"string" required:"true"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"RecommendationTemplateStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommendationTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommendationTemplateOutput) GoString() string { + return s.String() +} + +// SetRecommendationTemplateArn sets the RecommendationTemplateArn field's value. +func (s *DeleteRecommendationTemplateOutput) SetRecommendationTemplateArn(v string) *DeleteRecommendationTemplateOutput { + s.RecommendationTemplateArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DeleteRecommendationTemplateOutput) SetStatus(v string) *DeleteRecommendationTemplateOutput { + s.Status = &v + return s +} + +type DeleteResiliencyPolicyInput struct { + _ struct{} `type:"structure"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // PolicyArn is a required field + PolicyArn *string `locationName:"policyArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResiliencyPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResiliencyPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteResiliencyPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteResiliencyPolicyInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.PolicyArn == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *DeleteResiliencyPolicyInput) SetClientToken(v string) *DeleteResiliencyPolicyInput { + s.ClientToken = &v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *DeleteResiliencyPolicyInput) SetPolicyArn(v string) *DeleteResiliencyPolicyInput { + s.PolicyArn = &v + return s +} + +type DeleteResiliencyPolicyOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // PolicyArn is a required field + PolicyArn *string `locationName:"policyArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResiliencyPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResiliencyPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *DeleteResiliencyPolicyOutput) SetPolicyArn(v string) *DeleteResiliencyPolicyOutput { + s.PolicyArn = &v + return s +} + +type DescribeAppAssessmentInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAppAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAppAssessmentInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *DescribeAppAssessmentInput) SetAssessmentArn(v string) *DescribeAppAssessmentInput { + s.AssessmentArn = &v + return s +} + +type DescribeAppAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The assessment for an AWS Resilience Hub application, returned as an object. + // This object includes Amazon Resource Names (ARNs), compliance information, + // compliance status, cost, messages, resiliency scores, and more. + // + // Assessment is a required field + Assessment *AppAssessment `locationName:"assessment" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *DescribeAppAssessmentOutput) SetAssessment(v *AppAssessment) *DescribeAppAssessmentOutput { + s.Assessment = v + return s +} + +type DescribeAppInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAppInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAppInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeAppInput) SetAppArn(v string) *DescribeAppInput { + s.AppArn = &v + return s +} + +type DescribeAppOutput struct { + _ struct{} `type:"structure"` + + // The specified application, returned as an object with details including compliance + // status, creation time, description, resiliency score, and more. + // + // App is a required field + App *App `locationName:"app" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppOutput) GoString() string { + return s.String() +} + +// SetApp sets the App field's value. +func (s *DescribeAppOutput) SetApp(v *App) *DescribeAppOutput { + s.App = v + return s +} + +type DescribeAppVersionResourcesResolutionStatusInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The identifier for a specific resolution. + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionResourcesResolutionStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionResourcesResolutionStatusInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAppVersionResourcesResolutionStatusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAppVersionResourcesResolutionStatusInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + if s.ResolutionId != nil && len(*s.ResolutionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResolutionId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeAppVersionResourcesResolutionStatusInput) SetAppArn(v string) *DescribeAppVersionResourcesResolutionStatusInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *DescribeAppVersionResourcesResolutionStatusInput) SetAppVersion(v string) *DescribeAppVersionResourcesResolutionStatusInput { + s.AppVersion = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *DescribeAppVersionResourcesResolutionStatusInput) SetResolutionId(v string) *DescribeAppVersionResourcesResolutionStatusInput { + s.ResolutionId = &v + return s +} + +type DescribeAppVersionResourcesResolutionStatusOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The returned error message for the request. + ErrorMessage *string `locationName:"errorMessage" min:"1" type:"string"` + + // The identifier for a specific resolution. + // + // ResolutionId is a required field + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string" required:"true"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"ResourceResolutionStatusType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionResourcesResolutionStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionResourcesResolutionStatusOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeAppVersionResourcesResolutionStatusOutput) SetAppArn(v string) *DescribeAppVersionResourcesResolutionStatusOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *DescribeAppVersionResourcesResolutionStatusOutput) SetAppVersion(v string) *DescribeAppVersionResourcesResolutionStatusOutput { + s.AppVersion = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeAppVersionResourcesResolutionStatusOutput) SetErrorMessage(v string) *DescribeAppVersionResourcesResolutionStatusOutput { + s.ErrorMessage = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *DescribeAppVersionResourcesResolutionStatusOutput) SetResolutionId(v string) *DescribeAppVersionResourcesResolutionStatusOutput { + s.ResolutionId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeAppVersionResourcesResolutionStatusOutput) SetStatus(v string) *DescribeAppVersionResourcesResolutionStatusOutput { + s.Status = &v + return s +} + +type DescribeAppVersionTemplateInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAppVersionTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAppVersionTemplateInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeAppVersionTemplateInput) SetAppArn(v string) *DescribeAppVersionTemplateInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *DescribeAppVersionTemplateInput) SetAppVersion(v string) *DescribeAppVersionTemplateInput { + s.AppVersion = &v + return s +} + +type DescribeAppVersionTemplateOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The body of the template. + // + // AppTemplateBody is a required field + AppTemplateBody *string `locationName:"appTemplateBody" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeAppVersionTemplateOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeAppVersionTemplateOutput) SetAppArn(v string) *DescribeAppVersionTemplateOutput { + s.AppArn = &v + return s +} + +// SetAppTemplateBody sets the AppTemplateBody field's value. +func (s *DescribeAppVersionTemplateOutput) SetAppTemplateBody(v string) *DescribeAppVersionTemplateOutput { + s.AppTemplateBody = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *DescribeAppVersionTemplateOutput) SetAppVersion(v string) *DescribeAppVersionTemplateOutput { + s.AppVersion = &v + return s +} + +type DescribeDraftAppVersionResourcesImportStatusInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDraftAppVersionResourcesImportStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDraftAppVersionResourcesImportStatusInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDraftAppVersionResourcesImportStatusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDraftAppVersionResourcesImportStatusInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusInput) SetAppArn(v string) *DescribeDraftAppVersionResourcesImportStatusInput { + s.AppArn = &v + return s +} + +type DescribeDraftAppVersionResourcesImportStatusOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The returned error message for the request. + ErrorMessage *string `locationName:"errorMessage" min:"1" type:"string"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"ResourceImportStatusType"` + + // The timestamp for when the status last changed. + // + // StatusChangeTime is a required field + StatusChangeTime *time.Time `locationName:"statusChangeTime" type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDraftAppVersionResourcesImportStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDraftAppVersionResourcesImportStatusOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusOutput) SetAppArn(v string) *DescribeDraftAppVersionResourcesImportStatusOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusOutput) SetAppVersion(v string) *DescribeDraftAppVersionResourcesImportStatusOutput { + s.AppVersion = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusOutput) SetErrorMessage(v string) *DescribeDraftAppVersionResourcesImportStatusOutput { + s.ErrorMessage = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusOutput) SetStatus(v string) *DescribeDraftAppVersionResourcesImportStatusOutput { + s.Status = &v + return s +} + +// SetStatusChangeTime sets the StatusChangeTime field's value. +func (s *DescribeDraftAppVersionResourcesImportStatusOutput) SetStatusChangeTime(v time.Time) *DescribeDraftAppVersionResourcesImportStatusOutput { + s.StatusChangeTime = &v + return s +} + +type DescribeResiliencyPolicyInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // PolicyArn is a required field + PolicyArn *string `locationName:"policyArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeResiliencyPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeResiliencyPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeResiliencyPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeResiliencyPolicyInput"} + if s.PolicyArn == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *DescribeResiliencyPolicyInput) SetPolicyArn(v string) *DescribeResiliencyPolicyInput { + s.PolicyArn = &v + return s +} + +type DescribeResiliencyPolicyOutput struct { + _ struct{} `type:"structure"` + + // Information about the specific resiliency policy, returned as an object. + // This object includes creation time, data location constraints, its name, + // description, tags, the recovery time objective (RTO) and recovery point objective + // (RPO) in seconds, and more. + // + // Policy is a required field + Policy *ResiliencyPolicy `locationName:"policy" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeResiliencyPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeResiliencyPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicy sets the Policy field's value. +func (s *DescribeResiliencyPolicyOutput) SetPolicy(v *ResiliencyPolicy) *DescribeResiliencyPolicyOutput { + s.Policy = v + return s +} + +// Defines the compliance against the resiliency policy for a disruption. +type DisruptionCompliance struct { + _ struct{} `type:"structure"` + + // The Recovery Point Objective (RPO) that is achievable, in seconds. + AchievableRpoInSecs *int64 `locationName:"achievableRpoInSecs" type:"integer"` + + // The Recovery Time Objective (RTO) that is achievable, in seconds + AchievableRtoInSecs *int64 `locationName:"achievableRtoInSecs" type:"integer"` + + // The current status of compliance for the resiliency policy. + // + // ComplianceStatus is a required field + ComplianceStatus *string `locationName:"complianceStatus" type:"string" required:"true" enum:"ComplianceStatus"` + + // The current RPO, in seconds. + CurrentRpoInSecs *int64 `locationName:"currentRpoInSecs" type:"integer"` + + // The current RTO, in seconds. + CurrentRtoInSecs *int64 `locationName:"currentRtoInSecs" type:"integer"` + + // The disruption compliance message. + Message *string `locationName:"message" min:"1" type:"string"` + + // The RPO description. + RpoDescription *string `locationName:"rpoDescription" min:"1" type:"string"` + + // The RPO reference identifier. + RpoReferenceId *string `locationName:"rpoReferenceId" min:"1" type:"string"` + + // The RTO description. + RtoDescription *string `locationName:"rtoDescription" min:"1" type:"string"` + + // The RTO reference identifier. + RtoReferenceId *string `locationName:"rtoReferenceId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DisruptionCompliance) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DisruptionCompliance) GoString() string { + return s.String() +} + +// SetAchievableRpoInSecs sets the AchievableRpoInSecs field's value. +func (s *DisruptionCompliance) SetAchievableRpoInSecs(v int64) *DisruptionCompliance { + s.AchievableRpoInSecs = &v + return s +} + +// SetAchievableRtoInSecs sets the AchievableRtoInSecs field's value. +func (s *DisruptionCompliance) SetAchievableRtoInSecs(v int64) *DisruptionCompliance { + s.AchievableRtoInSecs = &v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *DisruptionCompliance) SetComplianceStatus(v string) *DisruptionCompliance { + s.ComplianceStatus = &v + return s +} + +// SetCurrentRpoInSecs sets the CurrentRpoInSecs field's value. +func (s *DisruptionCompliance) SetCurrentRpoInSecs(v int64) *DisruptionCompliance { + s.CurrentRpoInSecs = &v + return s +} + +// SetCurrentRtoInSecs sets the CurrentRtoInSecs field's value. +func (s *DisruptionCompliance) SetCurrentRtoInSecs(v int64) *DisruptionCompliance { + s.CurrentRtoInSecs = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DisruptionCompliance) SetMessage(v string) *DisruptionCompliance { + s.Message = &v + return s +} + +// SetRpoDescription sets the RpoDescription field's value. +func (s *DisruptionCompliance) SetRpoDescription(v string) *DisruptionCompliance { + s.RpoDescription = &v + return s +} + +// SetRpoReferenceId sets the RpoReferenceId field's value. +func (s *DisruptionCompliance) SetRpoReferenceId(v string) *DisruptionCompliance { + s.RpoReferenceId = &v + return s +} + +// SetRtoDescription sets the RtoDescription field's value. +func (s *DisruptionCompliance) SetRtoDescription(v string) *DisruptionCompliance { + s.RtoDescription = &v + return s +} + +// SetRtoReferenceId sets the RtoReferenceId field's value. +func (s *DisruptionCompliance) SetRtoReferenceId(v string) *DisruptionCompliance { + s.RtoReferenceId = &v + return s +} + +// Defines a failure policy. +type FailurePolicy struct { + _ struct{} `type:"structure"` + + // The Recovery Point Objective (RPO), in seconds. + // + // RpoInSecs is a required field + RpoInSecs *int64 `locationName:"rpoInSecs" type:"integer" required:"true"` + + // The Recovery Time Objective (RTO), in seconds. + // + // RtoInSecs is a required field + RtoInSecs *int64 `locationName:"rtoInSecs" type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailurePolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailurePolicy) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FailurePolicy) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FailurePolicy"} + if s.RpoInSecs == nil { + invalidParams.Add(request.NewErrParamRequired("RpoInSecs")) + } + if s.RtoInSecs == nil { + invalidParams.Add(request.NewErrParamRequired("RtoInSecs")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRpoInSecs sets the RpoInSecs field's value. +func (s *FailurePolicy) SetRpoInSecs(v int64) *FailurePolicy { + s.RpoInSecs = &v + return s +} + +// SetRtoInSecs sets the RtoInSecs field's value. +func (s *FailurePolicy) SetRtoInSecs(v int64) *FailurePolicy { + s.RtoInSecs = &v + return s +} + +type ImportResourcesToDraftAppVersionInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The Amazon Resource Names (ARNs) for the resources that you want to import. + // + // SourceArns is a required field + SourceArns []*string `locationName:"sourceArns" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportResourcesToDraftAppVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportResourcesToDraftAppVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ImportResourcesToDraftAppVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ImportResourcesToDraftAppVersionInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.SourceArns == nil { + invalidParams.Add(request.NewErrParamRequired("SourceArns")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ImportResourcesToDraftAppVersionInput) SetAppArn(v string) *ImportResourcesToDraftAppVersionInput { + s.AppArn = &v + return s +} + +// SetSourceArns sets the SourceArns field's value. +func (s *ImportResourcesToDraftAppVersionInput) SetSourceArns(v []*string) *ImportResourcesToDraftAppVersionInput { + s.SourceArns = v + return s +} + +type ImportResourcesToDraftAppVersionOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The Amazon Resource Names (ARNs) for the resources that you imported. + // + // SourceArns is a required field + SourceArns []*string `locationName:"sourceArns" type:"list" required:"true"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"ResourceImportStatusType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportResourcesToDraftAppVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportResourcesToDraftAppVersionOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *ImportResourcesToDraftAppVersionOutput) SetAppArn(v string) *ImportResourcesToDraftAppVersionOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ImportResourcesToDraftAppVersionOutput) SetAppVersion(v string) *ImportResourcesToDraftAppVersionOutput { + s.AppVersion = &v + return s +} + +// SetSourceArns sets the SourceArns field's value. +func (s *ImportResourcesToDraftAppVersionOutput) SetSourceArns(v []*string) *ImportResourcesToDraftAppVersionOutput { + s.SourceArns = v + return s +} + +// SetStatus sets the Status field's value. +func (s *ImportResourcesToDraftAppVersionOutput) SetStatus(v string) *ImportResourcesToDraftAppVersionOutput { + s.Status = &v + return s +} + +// This exception occurs when there is an internal failure in the AWS Resilience +// Hub service. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 ListAlarmRecommendationsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAlarmRecommendationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAlarmRecommendationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAlarmRecommendationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAlarmRecommendationsInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListAlarmRecommendationsInput) SetAssessmentArn(v string) *ListAlarmRecommendationsInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAlarmRecommendationsInput) SetMaxResults(v int64) *ListAlarmRecommendationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAlarmRecommendationsInput) SetNextToken(v string) *ListAlarmRecommendationsInput { + s.NextToken = &v + return s +} + +type ListAlarmRecommendationsOutput struct { + _ struct{} `type:"structure"` + + // The alarm recommendations for an AWS Resilience Hub application, returned + // as an object. This object includes application component names, descriptions, + // information about whether a recommendation has already been implemented or + // not, prerequisites, and more. + // + // AlarmRecommendations is a required field + AlarmRecommendations []*AlarmRecommendation `locationName:"alarmRecommendations" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAlarmRecommendationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAlarmRecommendationsOutput) GoString() string { + return s.String() +} + +// SetAlarmRecommendations sets the AlarmRecommendations field's value. +func (s *ListAlarmRecommendationsOutput) SetAlarmRecommendations(v []*AlarmRecommendation) *ListAlarmRecommendationsOutput { + s.AlarmRecommendations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAlarmRecommendationsOutput) SetNextToken(v string) *ListAlarmRecommendationsOutput { + s.NextToken = &v + return s +} + +type ListAppAssessmentsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `location:"querystring" locationName:"appArn" type:"string"` + + // The name for the assessment. + AssessmentName *string `location:"querystring" locationName:"assessmentName" type:"string"` + + // The current status of the assessment for the resiliency policy. + AssessmentStatus []*string `location:"querystring" locationName:"assessmentStatus" min:"1" type:"list"` + + // The current status of compliance for the resiliency policy. + ComplianceStatus *string `location:"querystring" locationName:"complianceStatus" type:"string" enum:"ComplianceStatus"` + + // Specifies the entity that invoked a specific assessment, either a User or + // the System. + Invoker *string `location:"querystring" locationName:"invoker" type:"string" enum:"AssessmentInvoker"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The default is to sort by ascending startTime. To sort by descending startTime, + // set reverseOrder to true. + ReverseOrder *bool `location:"querystring" locationName:"reverseOrder" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppAssessmentsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppAssessmentsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppAssessmentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppAssessmentsInput"} + if s.AssessmentStatus != nil && len(s.AssessmentStatus) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentStatus", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListAppAssessmentsInput) SetAppArn(v string) *ListAppAssessmentsInput { + s.AppArn = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *ListAppAssessmentsInput) SetAssessmentName(v string) *ListAppAssessmentsInput { + s.AssessmentName = &v + return s +} + +// SetAssessmentStatus sets the AssessmentStatus field's value. +func (s *ListAppAssessmentsInput) SetAssessmentStatus(v []*string) *ListAppAssessmentsInput { + s.AssessmentStatus = v + return s +} + +// SetComplianceStatus sets the ComplianceStatus field's value. +func (s *ListAppAssessmentsInput) SetComplianceStatus(v string) *ListAppAssessmentsInput { + s.ComplianceStatus = &v + return s +} + +// SetInvoker sets the Invoker field's value. +func (s *ListAppAssessmentsInput) SetInvoker(v string) *ListAppAssessmentsInput { + s.Invoker = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppAssessmentsInput) SetMaxResults(v int64) *ListAppAssessmentsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppAssessmentsInput) SetNextToken(v string) *ListAppAssessmentsInput { + s.NextToken = &v + return s +} + +// SetReverseOrder sets the ReverseOrder field's value. +func (s *ListAppAssessmentsInput) SetReverseOrder(v bool) *ListAppAssessmentsInput { + s.ReverseOrder = &v + return s +} + +type ListAppAssessmentsOutput struct { + _ struct{} `type:"structure"` + + // The summaries for the specified assessments, returned as an object. This + // object includes application versions, associated Amazon Resource Numbers + // (ARNs), cost, messages, resiliency scores, and more. + // + // AssessmentSummaries is a required field + AssessmentSummaries []*AppAssessmentSummary `locationName:"assessmentSummaries" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppAssessmentsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppAssessmentsOutput) GoString() string { + return s.String() +} + +// SetAssessmentSummaries sets the AssessmentSummaries field's value. +func (s *ListAppAssessmentsOutput) SetAssessmentSummaries(v []*AppAssessmentSummary) *ListAppAssessmentsOutput { + s.AssessmentSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppAssessmentsOutput) SetNextToken(v string) *ListAppAssessmentsOutput { + s.NextToken = &v + return s +} + +type ListAppComponentCompliancesInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentCompliancesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentCompliancesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppComponentCompliancesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppComponentCompliancesInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListAppComponentCompliancesInput) SetAssessmentArn(v string) *ListAppComponentCompliancesInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppComponentCompliancesInput) SetMaxResults(v int64) *ListAppComponentCompliancesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppComponentCompliancesInput) SetNextToken(v string) *ListAppComponentCompliancesInput { + s.NextToken = &v + return s +} + +type ListAppComponentCompliancesOutput struct { + _ struct{} `type:"structure"` + + // The compliances for an AWS Resilience Hub application component, returned + // as an object. This object contains component names, compliances, costs, resiliency + // scores, outage scores, and more. + // + // ComponentCompliances is a required field + ComponentCompliances []*AppComponentCompliance `locationName:"componentCompliances" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentCompliancesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentCompliancesOutput) GoString() string { + return s.String() +} + +// SetComponentCompliances sets the ComponentCompliances field's value. +func (s *ListAppComponentCompliancesOutput) SetComponentCompliances(v []*AppComponentCompliance) *ListAppComponentCompliancesOutput { + s.ComponentCompliances = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppComponentCompliancesOutput) SetNextToken(v string) *ListAppComponentCompliancesOutput { + s.NextToken = &v + return s +} + +type ListAppComponentRecommendationsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentRecommendationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentRecommendationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppComponentRecommendationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppComponentRecommendationsInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListAppComponentRecommendationsInput) SetAssessmentArn(v string) *ListAppComponentRecommendationsInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppComponentRecommendationsInput) SetMaxResults(v int64) *ListAppComponentRecommendationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppComponentRecommendationsInput) SetNextToken(v string) *ListAppComponentRecommendationsInput { + s.NextToken = &v + return s +} + +type ListAppComponentRecommendationsOutput struct { + _ struct{} `type:"structure"` + + // The recommendations for an Resilience Hub application component, returned + // as an object. This object contains component names, configuration recommendations, + // and recommendation statuses. + // + // ComponentRecommendations is a required field + ComponentRecommendations []*ComponentRecommendation `locationName:"componentRecommendations" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentRecommendationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppComponentRecommendationsOutput) GoString() string { + return s.String() +} + +// SetComponentRecommendations sets the ComponentRecommendations field's value. +func (s *ListAppComponentRecommendationsOutput) SetComponentRecommendations(v []*ComponentRecommendation) *ListAppComponentRecommendationsOutput { + s.ComponentRecommendations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppComponentRecommendationsOutput) SetNextToken(v string) *ListAppComponentRecommendationsOutput { + s.NextToken = &v + return s +} + +type ListAppVersionResourceMappingsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourceMappingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourceMappingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppVersionResourceMappingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppVersionResourceMappingsInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListAppVersionResourceMappingsInput) SetAppArn(v string) *ListAppVersionResourceMappingsInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ListAppVersionResourceMappingsInput) SetAppVersion(v string) *ListAppVersionResourceMappingsInput { + s.AppVersion = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppVersionResourceMappingsInput) SetMaxResults(v int64) *ListAppVersionResourceMappingsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionResourceMappingsInput) SetNextToken(v string) *ListAppVersionResourceMappingsInput { + s.NextToken = &v + return s +} + +type ListAppVersionResourceMappingsOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // Mappings used to map logical resources from the template to physical resources. + // You can use the mapping type CFN_STACK if the application template uses a + // logical stack name. Or you can map individual resources by using the mapping + // type RESOURCE. We recommend using the mapping type CFN_STACK if the application + // is backed by a CloudFormation stack. + // + // ResourceMappings is a required field + ResourceMappings []*ResourceMapping `locationName:"resourceMappings" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourceMappingsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourceMappingsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionResourceMappingsOutput) SetNextToken(v string) *ListAppVersionResourceMappingsOutput { + s.NextToken = &v + return s +} + +// SetResourceMappings sets the ResourceMappings field's value. +func (s *ListAppVersionResourceMappingsOutput) SetResourceMappings(v []*ResourceMapping) *ListAppVersionResourceMappingsOutput { + s.ResourceMappings = v + return s +} + +type ListAppVersionResourcesInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The identifier for a specific resolution. + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourcesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourcesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppVersionResourcesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppVersionResourcesInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.ResolutionId != nil && len(*s.ResolutionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResolutionId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListAppVersionResourcesInput) SetAppArn(v string) *ListAppVersionResourcesInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ListAppVersionResourcesInput) SetAppVersion(v string) *ListAppVersionResourcesInput { + s.AppVersion = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppVersionResourcesInput) SetMaxResults(v int64) *ListAppVersionResourcesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionResourcesInput) SetNextToken(v string) *ListAppVersionResourcesInput { + s.NextToken = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *ListAppVersionResourcesInput) SetResolutionId(v string) *ListAppVersionResourcesInput { + s.ResolutionId = &v + return s +} + +type ListAppVersionResourcesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The physical resources in the application version. + // + // PhysicalResources is a required field + PhysicalResources []*PhysicalResource `locationName:"physicalResources" type:"list" required:"true"` + + // The identifier for a specific resolution. + // + // ResolutionId is a required field + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourcesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionResourcesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionResourcesOutput) SetNextToken(v string) *ListAppVersionResourcesOutput { + s.NextToken = &v + return s +} + +// SetPhysicalResources sets the PhysicalResources field's value. +func (s *ListAppVersionResourcesOutput) SetPhysicalResources(v []*PhysicalResource) *ListAppVersionResourcesOutput { + s.PhysicalResources = v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *ListAppVersionResourcesOutput) SetResolutionId(v string) *ListAppVersionResourcesOutput { + s.ResolutionId = &v + return s +} + +type ListAppVersionsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppVersionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppVersionsInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListAppVersionsInput) SetAppArn(v string) *ListAppVersionsInput { + s.AppArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppVersionsInput) SetMaxResults(v int64) *ListAppVersionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionsInput) SetNextToken(v string) *ListAppVersionsInput { + s.NextToken = &v + return s +} + +type ListAppVersionsOutput struct { + _ struct{} `type:"structure"` + + // The version of the application. + // + // AppVersions is a required field + AppVersions []*AppVersionSummary `locationName:"appVersions" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppVersionsOutput) GoString() string { + return s.String() +} + +// SetAppVersions sets the AppVersions field's value. +func (s *ListAppVersionsOutput) SetAppVersions(v []*AppVersionSummary) *ListAppVersionsOutput { + s.AppVersions = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppVersionsOutput) SetNextToken(v string) *ListAppVersionsOutput { + s.NextToken = &v + return s +} + +type ListAppsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `location:"querystring" locationName:"appArn" type:"string"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The name for the one of the listed applications. + Name *string `location:"querystring" locationName:"name" type:"string"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAppsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAppsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListAppsInput) SetAppArn(v string) *ListAppsInput { + s.AppArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAppsInput) SetMaxResults(v int64) *ListAppsInput { + s.MaxResults = &v + return s +} + +// SetName sets the Name field's value. +func (s *ListAppsInput) SetName(v string) *ListAppsInput { + s.Name = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppsInput) SetNextToken(v string) *ListAppsInput { + s.NextToken = &v + return s +} + +type ListAppsOutput struct { + _ struct{} `type:"structure"` + + // Summaries for the Resilience Hub application. + // + // AppSummaries is a required field + AppSummaries []*AppSummary `locationName:"appSummaries" type:"list" required:"true"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAppsOutput) GoString() string { + return s.String() +} + +// SetAppSummaries sets the AppSummaries field's value. +func (s *ListAppsOutput) SetAppSummaries(v []*AppSummary) *ListAppsOutput { + s.AppSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAppsOutput) SetNextToken(v string) *ListAppsOutput { + s.NextToken = &v + return s +} + +type ListRecommendationTemplatesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `location:"querystring" locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The name for one of the listed recommendation templates. + Name *string `location:"querystring" locationName:"name" type:"string"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The Amazon Resource Name (ARN) for a recommendation template. + RecommendationTemplateArn *string `location:"querystring" locationName:"recommendationTemplateArn" type:"string"` + + // The default is to sort by ascending startTime. To sort by descending startTime, + // set reverseOrder to true. + ReverseOrder *bool `location:"querystring" locationName:"reverseOrder" type:"boolean"` + + // The status of the action. + Status []*string `location:"querystring" locationName:"status" min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendationTemplatesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendationTemplatesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRecommendationTemplatesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRecommendationTemplatesInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.Status != nil && len(s.Status) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Status", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListRecommendationTemplatesInput) SetAssessmentArn(v string) *ListRecommendationTemplatesInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRecommendationTemplatesInput) SetMaxResults(v int64) *ListRecommendationTemplatesInput { + s.MaxResults = &v + return s +} + +// SetName sets the Name field's value. +func (s *ListRecommendationTemplatesInput) SetName(v string) *ListRecommendationTemplatesInput { + s.Name = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRecommendationTemplatesInput) SetNextToken(v string) *ListRecommendationTemplatesInput { + s.NextToken = &v + return s +} + +// SetRecommendationTemplateArn sets the RecommendationTemplateArn field's value. +func (s *ListRecommendationTemplatesInput) SetRecommendationTemplateArn(v string) *ListRecommendationTemplatesInput { + s.RecommendationTemplateArn = &v + return s +} + +// SetReverseOrder sets the ReverseOrder field's value. +func (s *ListRecommendationTemplatesInput) SetReverseOrder(v bool) *ListRecommendationTemplatesInput { + s.ReverseOrder = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListRecommendationTemplatesInput) SetStatus(v []*string) *ListRecommendationTemplatesInput { + s.Status = v + return s +} + +type ListRecommendationTemplatesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The recommendation templates for the Resilience Hub applications. + RecommendationTemplates []*RecommendationTemplate `locationName:"recommendationTemplates" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendationTemplatesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendationTemplatesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRecommendationTemplatesOutput) SetNextToken(v string) *ListRecommendationTemplatesOutput { + s.NextToken = &v + return s +} + +// SetRecommendationTemplates sets the RecommendationTemplates field's value. +func (s *ListRecommendationTemplatesOutput) SetRecommendationTemplates(v []*RecommendationTemplate) *ListRecommendationTemplatesOutput { + s.RecommendationTemplates = v + return s +} + +type ListResiliencyPoliciesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // The name of the policy + PolicyName *string `location:"querystring" locationName:"policyName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListResiliencyPoliciesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListResiliencyPoliciesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListResiliencyPoliciesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListResiliencyPoliciesInput"} + 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 *ListResiliencyPoliciesInput) SetMaxResults(v int64) *ListResiliencyPoliciesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListResiliencyPoliciesInput) SetNextToken(v string) *ListResiliencyPoliciesInput { + s.NextToken = &v + return s +} + +// SetPolicyName sets the PolicyName field's value. +func (s *ListResiliencyPoliciesInput) SetPolicyName(v string) *ListResiliencyPoliciesInput { + s.PolicyName = &v + return s +} + +type ListResiliencyPoliciesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The resiliency policies for the Resilience Hub applications. + // + // ResiliencyPolicies is a required field + ResiliencyPolicies []*ResiliencyPolicy `locationName:"resiliencyPolicies" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListResiliencyPoliciesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListResiliencyPoliciesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListResiliencyPoliciesOutput) SetNextToken(v string) *ListResiliencyPoliciesOutput { + s.NextToken = &v + return s +} + +// SetResiliencyPolicies sets the ResiliencyPolicies field's value. +func (s *ListResiliencyPoliciesOutput) SetResiliencyPolicies(v []*ResiliencyPolicy) *ListResiliencyPoliciesOutput { + s.ResiliencyPolicies = v + return s +} + +type ListSopRecommendationsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSopRecommendationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSopRecommendationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSopRecommendationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSopRecommendationsInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListSopRecommendationsInput) SetAssessmentArn(v string) *ListSopRecommendationsInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSopRecommendationsInput) SetMaxResults(v int64) *ListSopRecommendationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSopRecommendationsInput) SetNextToken(v string) *ListSopRecommendationsInput { + s.NextToken = &v + return s +} + +type ListSopRecommendationsOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The standard operating procedure (SOP) recommendations for the Resilience + // Hub applications. + // + // SopRecommendations is a required field + SopRecommendations []*SopRecommendation `locationName:"sopRecommendations" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSopRecommendationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSopRecommendationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSopRecommendationsOutput) SetNextToken(v string) *ListSopRecommendationsOutput { + s.NextToken = &v + return s +} + +// SetSopRecommendations sets the SopRecommendations field's value. +func (s *ListSopRecommendationsOutput) SetSopRecommendations(v []*SopRecommendation) *ListSopRecommendationsOutput { + s.SopRecommendations = v + return s +} + +type ListSuggestedResiliencyPoliciesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSuggestedResiliencyPoliciesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSuggestedResiliencyPoliciesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSuggestedResiliencyPoliciesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSuggestedResiliencyPoliciesInput"} + 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 *ListSuggestedResiliencyPoliciesInput) SetMaxResults(v int64) *ListSuggestedResiliencyPoliciesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSuggestedResiliencyPoliciesInput) SetNextToken(v string) *ListSuggestedResiliencyPoliciesInput { + s.NextToken = &v + return s +} + +type ListSuggestedResiliencyPoliciesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The suggested resiliency policies for the Resilience Hub applications. + // + // ResiliencyPolicies is a required field + ResiliencyPolicies []*ResiliencyPolicy `locationName:"resiliencyPolicies" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSuggestedResiliencyPoliciesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSuggestedResiliencyPoliciesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSuggestedResiliencyPoliciesOutput) SetNextToken(v string) *ListSuggestedResiliencyPoliciesOutput { + s.NextToken = &v + return s +} + +// SetResiliencyPolicies sets the ResiliencyPolicies field's value. +func (s *ListSuggestedResiliencyPoliciesOutput) SetResiliencyPolicies(v []*ResiliencyPolicy) *ListSuggestedResiliencyPoliciesOutput { + s.ResiliencyPolicies = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) for a specific resource in your Resilience + // Hub application. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + 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 *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ListTagsForResourceOutput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +type ListTestRecommendationsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTestRecommendationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTestRecommendationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTestRecommendationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTestRecommendationsInput"} + if s.AssessmentArn == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentArn")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *ListTestRecommendationsInput) SetAssessmentArn(v string) *ListTestRecommendationsInput { + s.AssessmentArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListTestRecommendationsInput) SetMaxResults(v int64) *ListTestRecommendationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListTestRecommendationsInput) SetNextToken(v string) *ListTestRecommendationsInput { + s.NextToken = &v + return s +} + +type ListTestRecommendationsOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The test recommendations for the Resilience Hub application. + // + // TestRecommendations is a required field + TestRecommendations []*TestRecommendation `locationName:"testRecommendations" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTestRecommendationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTestRecommendationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListTestRecommendationsOutput) SetNextToken(v string) *ListTestRecommendationsOutput { + s.NextToken = &v + return s +} + +// SetTestRecommendations sets the TestRecommendations field's value. +func (s *ListTestRecommendationsOutput) SetTestRecommendations(v []*TestRecommendation) *ListTestRecommendationsOutput { + s.TestRecommendations = v + return s +} + +type ListUnsupportedAppVersionResourcesInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The maximum number of results to include in the response. If more results + // exist than the specified MaxResults value, a token is included in the response + // so that the remaining results can be retrieved. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // Null, or the token from a previous call to get the next set of results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The identifier for a specific resolution. + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListUnsupportedAppVersionResourcesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListUnsupportedAppVersionResourcesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListUnsupportedAppVersionResourcesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListUnsupportedAppVersionResourcesInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.ResolutionId != nil && len(*s.ResolutionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResolutionId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ListUnsupportedAppVersionResourcesInput) SetAppArn(v string) *ListUnsupportedAppVersionResourcesInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ListUnsupportedAppVersionResourcesInput) SetAppVersion(v string) *ListUnsupportedAppVersionResourcesInput { + s.AppVersion = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListUnsupportedAppVersionResourcesInput) SetMaxResults(v int64) *ListUnsupportedAppVersionResourcesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListUnsupportedAppVersionResourcesInput) SetNextToken(v string) *ListUnsupportedAppVersionResourcesInput { + s.NextToken = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *ListUnsupportedAppVersionResourcesInput) SetResolutionId(v string) *ListUnsupportedAppVersionResourcesInput { + s.ResolutionId = &v + return s +} + +type ListUnsupportedAppVersionResourcesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `locationName:"nextToken" type:"string"` + + // The identifier for a specific resolution. + // + // ResolutionId is a required field + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string" required:"true"` + + // The unsupported resources for the application. + // + // UnsupportedResources is a required field + UnsupportedResources []*UnsupportedResource `locationName:"unsupportedResources" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListUnsupportedAppVersionResourcesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListUnsupportedAppVersionResourcesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListUnsupportedAppVersionResourcesOutput) SetNextToken(v string) *ListUnsupportedAppVersionResourcesOutput { + s.NextToken = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *ListUnsupportedAppVersionResourcesOutput) SetResolutionId(v string) *ListUnsupportedAppVersionResourcesOutput { + s.ResolutionId = &v + return s +} + +// SetUnsupportedResources sets the UnsupportedResources field's value. +func (s *ListUnsupportedAppVersionResourcesOutput) SetUnsupportedResources(v []*UnsupportedResource) *ListUnsupportedAppVersionResourcesOutput { + s.UnsupportedResources = v + return s +} + +// Defines a logical resource identifier. +type LogicalResourceId struct { + _ struct{} `type:"structure"` + + // The identifier of the resource. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` + + // The name of the CloudFormation stack this resource belongs to. + LogicalStackName *string `locationName:"logicalStackName" min:"1" type:"string"` + + // The name of the resource group that this resource belongs to. + ResourceGroupName *string `locationName:"resourceGroupName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogicalResourceId) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LogicalResourceId) GoString() string { + return s.String() +} + +// SetIdentifier sets the Identifier field's value. +func (s *LogicalResourceId) SetIdentifier(v string) *LogicalResourceId { + s.Identifier = &v + return s +} + +// SetLogicalStackName sets the LogicalStackName field's value. +func (s *LogicalResourceId) SetLogicalStackName(v string) *LogicalResourceId { + s.LogicalStackName = &v + return s +} + +// SetResourceGroupName sets the ResourceGroupName field's value. +func (s *LogicalResourceId) SetResourceGroupName(v string) *LogicalResourceId { + s.ResourceGroupName = &v + return s +} + +// Defines a physical resource. A physical resource is a resource that exists +// in your account. It can be identified using an Amazon Resource Name (ARN) +// or a Resilience Hub-native identifier. +type PhysicalResource struct { + _ struct{} `type:"structure"` + + // The application components that belong to this resource. + AppComponents []*AppComponent `locationName:"appComponents" type:"list"` + + // The logical identifier of the resource. + // + // LogicalResourceId is a required field + LogicalResourceId *LogicalResourceId `locationName:"logicalResourceId" type:"structure" required:"true"` + + // The physical identifier of the resource. + // + // PhysicalResourceId is a required field + PhysicalResourceId *PhysicalResourceId `locationName:"physicalResourceId" type:"structure" required:"true"` + + // The name of the resource. + ResourceName *string `locationName:"resourceName" type:"string"` + + // The type of resource. + // + // ResourceType is a required field + ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PhysicalResource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PhysicalResource) GoString() string { + return s.String() +} + +// SetAppComponents sets the AppComponents field's value. +func (s *PhysicalResource) SetAppComponents(v []*AppComponent) *PhysicalResource { + s.AppComponents = v + return s +} + +// SetLogicalResourceId sets the LogicalResourceId field's value. +func (s *PhysicalResource) SetLogicalResourceId(v *LogicalResourceId) *PhysicalResource { + s.LogicalResourceId = v + return s +} + +// SetPhysicalResourceId sets the PhysicalResourceId field's value. +func (s *PhysicalResource) SetPhysicalResourceId(v *PhysicalResourceId) *PhysicalResource { + s.PhysicalResourceId = v + return s +} + +// SetResourceName sets the ResourceName field's value. +func (s *PhysicalResource) SetResourceName(v string) *PhysicalResource { + s.ResourceName = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *PhysicalResource) SetResourceType(v string) *PhysicalResource { + s.ResourceType = &v + return s +} + +// Defines a physical resource identifier. +type PhysicalResourceId struct { + _ struct{} `type:"structure"` + + // The Amazon Web Services account that owns the physical resource. + AwsAccountId *string `locationName:"awsAccountId" type:"string"` + + // The Amazon Web Services Region that the physical resource is located in. + AwsRegion *string `locationName:"awsRegion" type:"string"` + + // The identifier of the physical resource. + // + // Identifier is a required field + Identifier *string `locationName:"identifier" min:"1" type:"string" required:"true"` + + // Specifies the type of physical resource identifier. + // + // Arn + // + // The resource identifier is an Amazon Resource Name (ARN) . + // + // Native + // + // The resource identifier is a Resilience Hub-native identifier. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"PhysicalIdentifierType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PhysicalResourceId) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PhysicalResourceId) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PhysicalResourceId) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PhysicalResourceId"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *PhysicalResourceId) SetAwsAccountId(v string) *PhysicalResourceId { + s.AwsAccountId = &v + return s +} + +// SetAwsRegion sets the AwsRegion field's value. +func (s *PhysicalResourceId) SetAwsRegion(v string) *PhysicalResourceId { + s.AwsRegion = &v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *PhysicalResourceId) SetIdentifier(v string) *PhysicalResourceId { + s.Identifier = &v + return s +} + +// SetType sets the Type field's value. +func (s *PhysicalResourceId) SetType(v string) *PhysicalResourceId { + s.Type = &v + return s +} + +type PublishAppVersionInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublishAppVersionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublishAppVersionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PublishAppVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PublishAppVersionInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *PublishAppVersionInput) SetAppArn(v string) *PublishAppVersionInput { + s.AppArn = &v + return s +} + +type PublishAppVersionOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + AppVersion *string `locationName:"appVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublishAppVersionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublishAppVersionOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *PublishAppVersionOutput) SetAppArn(v string) *PublishAppVersionOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *PublishAppVersionOutput) SetAppVersion(v string) *PublishAppVersionOutput { + s.AppVersion = &v + return s +} + +type PutDraftAppVersionTemplateInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // A JSON string that contains the body of the app template. + // + // AppTemplateBody is a required field + AppTemplateBody *string `locationName:"appTemplateBody" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutDraftAppVersionTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutDraftAppVersionTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutDraftAppVersionTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutDraftAppVersionTemplateInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppTemplateBody == nil { + invalidParams.Add(request.NewErrParamRequired("AppTemplateBody")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *PutDraftAppVersionTemplateInput) SetAppArn(v string) *PutDraftAppVersionTemplateInput { + s.AppArn = &v + return s +} + +// SetAppTemplateBody sets the AppTemplateBody field's value. +func (s *PutDraftAppVersionTemplateInput) SetAppTemplateBody(v string) *PutDraftAppVersionTemplateInput { + s.AppTemplateBody = &v + return s +} + +type PutDraftAppVersionTemplateOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `locationName:"appArn" type:"string"` + + // The version of the application. + AppVersion *string `locationName:"appVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutDraftAppVersionTemplateOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutDraftAppVersionTemplateOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *PutDraftAppVersionTemplateOutput) SetAppArn(v string) *PutDraftAppVersionTemplateOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *PutDraftAppVersionTemplateOutput) SetAppVersion(v string) *PutDraftAppVersionTemplateOutput { + s.AppVersion = &v + return s +} + +// Defines a disruption compliance recommendation. +type RecommendationDisruptionCompliance struct { + _ struct{} `type:"structure"` + + // The expected compliance status after applying the recommended configuration + // change. + // + // ExpectedComplianceStatus is a required field + ExpectedComplianceStatus *string `locationName:"expectedComplianceStatus" type:"string" required:"true" enum:"ComplianceStatus"` + + // The expected Recovery Point Objective (RPO) description after applying the + // recommended configuration change. + ExpectedRpoDescription *string `locationName:"expectedRpoDescription" min:"1" type:"string"` + + // The expected RPO after applying the recommended configuration change. + ExpectedRpoInSecs *int64 `locationName:"expectedRpoInSecs" type:"integer"` + + // The expected Recovery Time Objective (RTO) description after applying the + // recommended configuration change. + ExpectedRtoDescription *string `locationName:"expectedRtoDescription" min:"1" type:"string"` + + // The expected RTO after applying the recommended configuration change. + ExpectedRtoInSecs *int64 `locationName:"expectedRtoInSecs" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDisruptionCompliance) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationDisruptionCompliance) GoString() string { + return s.String() +} + +// SetExpectedComplianceStatus sets the ExpectedComplianceStatus field's value. +func (s *RecommendationDisruptionCompliance) SetExpectedComplianceStatus(v string) *RecommendationDisruptionCompliance { + s.ExpectedComplianceStatus = &v + return s +} + +// SetExpectedRpoDescription sets the ExpectedRpoDescription field's value. +func (s *RecommendationDisruptionCompliance) SetExpectedRpoDescription(v string) *RecommendationDisruptionCompliance { + s.ExpectedRpoDescription = &v + return s +} + +// SetExpectedRpoInSecs sets the ExpectedRpoInSecs field's value. +func (s *RecommendationDisruptionCompliance) SetExpectedRpoInSecs(v int64) *RecommendationDisruptionCompliance { + s.ExpectedRpoInSecs = &v + return s +} + +// SetExpectedRtoDescription sets the ExpectedRtoDescription field's value. +func (s *RecommendationDisruptionCompliance) SetExpectedRtoDescription(v string) *RecommendationDisruptionCompliance { + s.ExpectedRtoDescription = &v + return s +} + +// SetExpectedRtoInSecs sets the ExpectedRtoInSecs field's value. +func (s *RecommendationDisruptionCompliance) SetExpectedRtoInSecs(v int64) *RecommendationDisruptionCompliance { + s.ExpectedRtoInSecs = &v + return s +} + +// Defines a recommendation. +type RecommendationItem struct { + _ struct{} `type:"structure"` + + // Specifies if the recommendation has already been implemented. + AlreadyImplemented *bool `locationName:"alreadyImplemented" type:"boolean"` + + // The resource identifier. + ResourceId *string `locationName:"resourceId" min:"1" type:"string"` + + // The target account identifier. + TargetAccountId *string `locationName:"targetAccountId" type:"string"` + + // The target region. + TargetRegion *string `locationName:"targetRegion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationItem) GoString() string { + return s.String() +} + +// SetAlreadyImplemented sets the AlreadyImplemented field's value. +func (s *RecommendationItem) SetAlreadyImplemented(v bool) *RecommendationItem { + s.AlreadyImplemented = &v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *RecommendationItem) SetResourceId(v string) *RecommendationItem { + s.ResourceId = &v + return s +} + +// SetTargetAccountId sets the TargetAccountId field's value. +func (s *RecommendationItem) SetTargetAccountId(v string) *RecommendationItem { + s.TargetAccountId = &v + return s +} + +// SetTargetRegion sets the TargetRegion field's value. +func (s *RecommendationItem) SetTargetRegion(v string) *RecommendationItem { + s.TargetRegion = &v + return s +} + +// Defines a recommendation template created with the CreateRecommendationTemplate +// action. +type RecommendationTemplate struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `locationName:"appArn" type:"string"` + + // The Amazon Resource Name (ARN) of the assessment. The format for this ARN + // is: arn:partition:dcps:region:account:app-assessment/app-id. For more information + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AssessmentArn is a required field + AssessmentArn *string `locationName:"assessmentArn" type:"string" required:"true"` + + // The end time for the action. + EndTime *time.Time `locationName:"endTime" type:"timestamp"` + + // The format of the recommendation template. + // + // CfnJson + // + // The template is CloudFormation JSON. + // + // CfnYaml + // + // The template is CloudFormation YAML. + // + // Format is a required field + Format *string `locationName:"format" type:"string" required:"true" enum:"TemplateFormat"` + + // The message for the recommendation template. + Message *string `locationName:"message" min:"1" type:"string"` + + // The name for the recommendation template. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // Indicates if replacements are needed. + NeedsReplacements *bool `locationName:"needsReplacements" type:"boolean"` + + // Identifiers for the recommendations used in the recommendation template. + RecommendationIds []*string `locationName:"recommendationIds" min:"1" type:"list"` + + // The Amazon Resource Name (ARN) for the recommendation template. + // + // RecommendationTemplateArn is a required field + RecommendationTemplateArn *string `locationName:"recommendationTemplateArn" type:"string" required:"true"` + + // An array of strings that specify the recommendation template type or types. + // + // Alarm + // + // The template is an AlarmRecommendation template. + // + // Sop + // + // The template is a SopRecommendation template. + // + // Test + // + // The template is a TestRecommendation template. + // + // RecommendationTypes is a required field + RecommendationTypes []*string `locationName:"recommendationTypes" min:"1" type:"list" required:"true"` + + // The start time for the action. + StartTime *time.Time `locationName:"startTime" type:"timestamp"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"RecommendationTemplateStatus"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by RecommendationTemplate's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` + + // The file location of the template. + TemplatesLocation *S3Location `locationName:"templatesLocation" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationTemplate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecommendationTemplate) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *RecommendationTemplate) SetAppArn(v string) *RecommendationTemplate { + s.AppArn = &v + return s +} + +// SetAssessmentArn sets the AssessmentArn field's value. +func (s *RecommendationTemplate) SetAssessmentArn(v string) *RecommendationTemplate { + s.AssessmentArn = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *RecommendationTemplate) SetEndTime(v time.Time) *RecommendationTemplate { + s.EndTime = &v + return s +} + +// SetFormat sets the Format field's value. +func (s *RecommendationTemplate) SetFormat(v string) *RecommendationTemplate { + s.Format = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *RecommendationTemplate) SetMessage(v string) *RecommendationTemplate { + s.Message = &v + return s +} + +// SetName sets the Name field's value. +func (s *RecommendationTemplate) SetName(v string) *RecommendationTemplate { + s.Name = &v + return s +} + +// SetNeedsReplacements sets the NeedsReplacements field's value. +func (s *RecommendationTemplate) SetNeedsReplacements(v bool) *RecommendationTemplate { + s.NeedsReplacements = &v + return s +} + +// SetRecommendationIds sets the RecommendationIds field's value. +func (s *RecommendationTemplate) SetRecommendationIds(v []*string) *RecommendationTemplate { + s.RecommendationIds = v + return s +} + +// SetRecommendationTemplateArn sets the RecommendationTemplateArn field's value. +func (s *RecommendationTemplate) SetRecommendationTemplateArn(v string) *RecommendationTemplate { + s.RecommendationTemplateArn = &v + return s +} + +// SetRecommendationTypes sets the RecommendationTypes field's value. +func (s *RecommendationTemplate) SetRecommendationTypes(v []*string) *RecommendationTemplate { + s.RecommendationTypes = v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *RecommendationTemplate) SetStartTime(v time.Time) *RecommendationTemplate { + s.StartTime = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *RecommendationTemplate) SetStatus(v string) *RecommendationTemplate { + s.Status = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *RecommendationTemplate) SetTags(v map[string]*string) *RecommendationTemplate { + s.Tags = v + return s +} + +// SetTemplatesLocation sets the TemplatesLocation field's value. +func (s *RecommendationTemplate) SetTemplatesLocation(v *S3Location) *RecommendationTemplate { + s.TemplatesLocation = v + return s +} + +type RemoveDraftAppVersionResourceMappingsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The names of the registered applications to remove from the resource mappings. + AppRegistryAppNames []*string `locationName:"appRegistryAppNames" type:"list"` + + // The names of the CloudFormation stacks to remove from the resource mappings. + LogicalStackNames []*string `locationName:"logicalStackNames" type:"list"` + + // The names of the resource groups to remove from the resource mappings. + ResourceGroupNames []*string `locationName:"resourceGroupNames" type:"list"` + + // The names of the resources to remove from the resource mappings. + ResourceNames []*string `locationName:"resourceNames" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveDraftAppVersionResourceMappingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveDraftAppVersionResourceMappingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RemoveDraftAppVersionResourceMappingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RemoveDraftAppVersionResourceMappingsInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *RemoveDraftAppVersionResourceMappingsInput) SetAppArn(v string) *RemoveDraftAppVersionResourceMappingsInput { + s.AppArn = &v + return s +} + +// SetAppRegistryAppNames sets the AppRegistryAppNames field's value. +func (s *RemoveDraftAppVersionResourceMappingsInput) SetAppRegistryAppNames(v []*string) *RemoveDraftAppVersionResourceMappingsInput { + s.AppRegistryAppNames = v + return s +} + +// SetLogicalStackNames sets the LogicalStackNames field's value. +func (s *RemoveDraftAppVersionResourceMappingsInput) SetLogicalStackNames(v []*string) *RemoveDraftAppVersionResourceMappingsInput { + s.LogicalStackNames = v + return s +} + +// SetResourceGroupNames sets the ResourceGroupNames field's value. +func (s *RemoveDraftAppVersionResourceMappingsInput) SetResourceGroupNames(v []*string) *RemoveDraftAppVersionResourceMappingsInput { + s.ResourceGroupNames = v + return s +} + +// SetResourceNames sets the ResourceNames field's value. +func (s *RemoveDraftAppVersionResourceMappingsInput) SetResourceNames(v []*string) *RemoveDraftAppVersionResourceMappingsInput { + s.ResourceNames = v + return s +} + +type RemoveDraftAppVersionResourceMappingsOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + AppArn *string `locationName:"appArn" type:"string"` + + // The version of the application. + AppVersion *string `locationName:"appVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveDraftAppVersionResourceMappingsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RemoveDraftAppVersionResourceMappingsOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *RemoveDraftAppVersionResourceMappingsOutput) SetAppArn(v string) *RemoveDraftAppVersionResourceMappingsOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *RemoveDraftAppVersionResourceMappingsOutput) SetAppVersion(v string) *RemoveDraftAppVersionResourceMappingsOutput { + s.AppVersion = &v + return s +} + +// Defines a resiliency policy. +type ResiliencyPolicy struct { + _ struct{} `type:"structure"` + + // The timestamp for when the resiliency policy was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // Specifies a high-level geographical location constraint for where your resilience + // policy data can be stored. + DataLocationConstraint *string `locationName:"dataLocationConstraint" type:"string" enum:"DataLocationConstraint"` + + // Specifies the estimated cost tier of the resiliency policy. + EstimatedCostTier *string `locationName:"estimatedCostTier" type:"string" enum:"EstimatedCostTier"` + + // The resiliency policy. + Policy map[string]*FailurePolicy `locationName:"policy" type:"map"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + PolicyArn *string `locationName:"policyArn" type:"string"` + + // The description for the policy. + PolicyDescription *string `locationName:"policyDescription" type:"string"` + + // The name of the policy + PolicyName *string `locationName:"policyName" type:"string"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ResiliencyPolicy's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` + + // The tier for this resiliency policy, ranging from the highest severity (MissionCritical) + // to lowest (NonCritical). + Tier *string `locationName:"tier" type:"string" enum:"ResiliencyPolicyTier"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResiliencyPolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResiliencyPolicy) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *ResiliencyPolicy) SetCreationTime(v time.Time) *ResiliencyPolicy { + s.CreationTime = &v + return s +} + +// SetDataLocationConstraint sets the DataLocationConstraint field's value. +func (s *ResiliencyPolicy) SetDataLocationConstraint(v string) *ResiliencyPolicy { + s.DataLocationConstraint = &v + return s +} + +// SetEstimatedCostTier sets the EstimatedCostTier field's value. +func (s *ResiliencyPolicy) SetEstimatedCostTier(v string) *ResiliencyPolicy { + s.EstimatedCostTier = &v + return s +} + +// SetPolicy sets the Policy field's value. +func (s *ResiliencyPolicy) SetPolicy(v map[string]*FailurePolicy) *ResiliencyPolicy { + s.Policy = v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *ResiliencyPolicy) SetPolicyArn(v string) *ResiliencyPolicy { + s.PolicyArn = &v + return s +} + +// SetPolicyDescription sets the PolicyDescription field's value. +func (s *ResiliencyPolicy) SetPolicyDescription(v string) *ResiliencyPolicy { + s.PolicyDescription = &v + return s +} + +// SetPolicyName sets the PolicyName field's value. +func (s *ResiliencyPolicy) SetPolicyName(v string) *ResiliencyPolicy { + s.PolicyName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ResiliencyPolicy) SetTags(v map[string]*string) *ResiliencyPolicy { + s.Tags = v + return s +} + +// SetTier sets the Tier field's value. +func (s *ResiliencyPolicy) SetTier(v string) *ResiliencyPolicy { + s.Tier = &v + return s +} + +// The overall resiliency score, returned as an object that includes the disruption +// score and outage score. +type ResiliencyScore struct { + _ struct{} `type:"structure"` + + // The disruption score for a valid key. + // + // DisruptionScore is a required field + DisruptionScore map[string]*float64 `locationName:"disruptionScore" type:"map" required:"true"` + + // The outage score for a valid key. + // + // Score is a required field + Score *float64 `locationName:"score" type:"double" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResiliencyScore) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResiliencyScore) GoString() string { + return s.String() +} + +// SetDisruptionScore sets the DisruptionScore field's value. +func (s *ResiliencyScore) SetDisruptionScore(v map[string]*float64) *ResiliencyScore { + s.DisruptionScore = v + return s +} + +// SetScore sets the Score field's value. +func (s *ResiliencyScore) SetScore(v float64) *ResiliencyScore { + s.Score = &v + return s +} + +type ResolveAppVersionResourcesInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResolveAppVersionResourcesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResolveAppVersionResourcesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ResolveAppVersionResourcesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResolveAppVersionResourcesInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *ResolveAppVersionResourcesInput) SetAppArn(v string) *ResolveAppVersionResourcesInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ResolveAppVersionResourcesInput) SetAppVersion(v string) *ResolveAppVersionResourcesInput { + s.AppVersion = &v + return s +} + +type ResolveAppVersionResourcesOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The identifier for a specific resolution. + // + // ResolutionId is a required field + ResolutionId *string `locationName:"resolutionId" min:"1" type:"string" required:"true"` + + // The status of the action. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"ResourceResolutionStatusType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResolveAppVersionResourcesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResolveAppVersionResourcesOutput) GoString() string { + return s.String() +} + +// SetAppArn sets the AppArn field's value. +func (s *ResolveAppVersionResourcesOutput) SetAppArn(v string) *ResolveAppVersionResourcesOutput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *ResolveAppVersionResourcesOutput) SetAppVersion(v string) *ResolveAppVersionResourcesOutput { + s.AppVersion = &v + return s +} + +// SetResolutionId sets the ResolutionId field's value. +func (s *ResolveAppVersionResourcesOutput) SetResolutionId(v string) *ResolveAppVersionResourcesOutput { + s.ResolutionId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ResolveAppVersionResourcesOutput) SetStatus(v string) *ResolveAppVersionResourcesOutput { + s.Status = &v + return s +} + +// Defines a resource mapping. +type ResourceMapping struct { + _ struct{} `type:"structure"` + + // The name of the application this resource is mapped to. + AppRegistryAppName *string `locationName:"appRegistryAppName" type:"string"` + + // The name of the CloudFormation stack this resource is mapped to. + LogicalStackName *string `locationName:"logicalStackName" min:"1" type:"string"` + + // Specifies the type of resource mapping. + // + // AppRegistryApp + // + // The resource is mapped to another application. The name of the application + // is contained in the appRegistryAppName property. + // + // CfnStack + // + // The resource is mapped to a CloudFormation stack. The name of the CloudFormation + // stack is contained in the logicalStackName property. + // + // Resource + // + // The resource is mapped to another resource. The name of the resource is contained + // in the resourceName property. + // + // ResourceGroup + // + // The resource is mapped to a resource group. The name of the resource group + // is contained in the resourceGroupName property. + // + // MappingType is a required field + MappingType *string `locationName:"mappingType" type:"string" required:"true" enum:"ResourceMappingType"` + + // The identifier of this resource. + // + // PhysicalResourceId is a required field + PhysicalResourceId *PhysicalResourceId `locationName:"physicalResourceId" type:"structure" required:"true"` + + // The name of the resource group this resource is mapped to. + ResourceGroupName *string `locationName:"resourceGroupName" type:"string"` + + // The name of the resource this resource is mapped to. + ResourceName *string `locationName:"resourceName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceMapping) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceMapping) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ResourceMapping) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResourceMapping"} + if s.LogicalStackName != nil && len(*s.LogicalStackName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogicalStackName", 1)) + } + if s.MappingType == nil { + invalidParams.Add(request.NewErrParamRequired("MappingType")) + } + if s.PhysicalResourceId == nil { + invalidParams.Add(request.NewErrParamRequired("PhysicalResourceId")) + } + if s.PhysicalResourceId != nil { + if err := s.PhysicalResourceId.Validate(); err != nil { + invalidParams.AddNested("PhysicalResourceId", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppRegistryAppName sets the AppRegistryAppName field's value. +func (s *ResourceMapping) SetAppRegistryAppName(v string) *ResourceMapping { + s.AppRegistryAppName = &v + return s +} + +// SetLogicalStackName sets the LogicalStackName field's value. +func (s *ResourceMapping) SetLogicalStackName(v string) *ResourceMapping { + s.LogicalStackName = &v + return s +} + +// SetMappingType sets the MappingType field's value. +func (s *ResourceMapping) SetMappingType(v string) *ResourceMapping { + s.MappingType = &v + return s +} + +// SetPhysicalResourceId sets the PhysicalResourceId field's value. +func (s *ResourceMapping) SetPhysicalResourceId(v *PhysicalResourceId) *ResourceMapping { + s.PhysicalResourceId = v + return s +} + +// SetResourceGroupName sets the ResourceGroupName field's value. +func (s *ResourceMapping) SetResourceGroupName(v string) *ResourceMapping { + s.ResourceGroupName = &v + return s +} + +// SetResourceName sets the ResourceName field's value. +func (s *ResourceMapping) SetResourceName(v string) *ResourceMapping { + s.ResourceName = &v + return s +} + +// The specified resource could not be found. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` + + // The identifier of the resource that the exception applies to. + ResourceId *string `locationName:"resourceId" type:"string"` + + // The type of the resource that the exception applies to. + ResourceType *string `locationName:"resourceType" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 location of the Amazon S3 bucket. +type S3Location struct { + _ struct{} `type:"structure"` + + // The name of the Amazon S3 bucket. + Bucket *string `locationName:"bucket" min:"1" type:"string"` + + // The prefix for the Amazon S3 bucket. + Prefix *string `locationName:"prefix" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Location) GoString() string { + return s.String() +} + +// SetBucket sets the Bucket field's value. +func (s *S3Location) SetBucket(v string) *S3Location { + s.Bucket = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *S3Location) SetPrefix(v string) *S3Location { + s.Prefix = &v + return s +} + +// You have exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use Service Quotas to request a service +// quota increase. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 +} + +// Defines a standard operating procedure (SOP) recommendation. +type SopRecommendation struct { + _ struct{} `type:"structure"` + + // The application component name. + AppComponentName *string `locationName:"appComponentName" type:"string"` + + // The description of the SOP recommendation. + Description *string `locationName:"description" min:"1" type:"string"` + + // The recommendation items. + Items []*RecommendationItem `locationName:"items" type:"list"` + + // The name of the SOP recommendation. + Name *string `locationName:"name" min:"1" type:"string"` + + // The prerequisite for the SOP recommendation. + Prerequisite *string `locationName:"prerequisite" min:"1" type:"string"` + + // Identifier for the SOP recommendation. + // + // RecommendationId is a required field + RecommendationId *string `locationName:"recommendationId" type:"string" required:"true"` + + // The reference identifier for the SOP recommendation. + // + // ReferenceId is a required field + ReferenceId *string `locationName:"referenceId" min:"1" type:"string" required:"true"` + + // The service type. + // + // ServiceType is a required field + ServiceType *string `locationName:"serviceType" type:"string" required:"true" enum:"SopServiceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SopRecommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SopRecommendation) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *SopRecommendation) SetAppComponentName(v string) *SopRecommendation { + s.AppComponentName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *SopRecommendation) SetDescription(v string) *SopRecommendation { + s.Description = &v + return s +} + +// SetItems sets the Items field's value. +func (s *SopRecommendation) SetItems(v []*RecommendationItem) *SopRecommendation { + s.Items = v + return s +} + +// SetName sets the Name field's value. +func (s *SopRecommendation) SetName(v string) *SopRecommendation { + s.Name = &v + return s +} + +// SetPrerequisite sets the Prerequisite field's value. +func (s *SopRecommendation) SetPrerequisite(v string) *SopRecommendation { + s.Prerequisite = &v + return s +} + +// SetRecommendationId sets the RecommendationId field's value. +func (s *SopRecommendation) SetRecommendationId(v string) *SopRecommendation { + s.RecommendationId = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *SopRecommendation) SetReferenceId(v string) *SopRecommendation { + s.ReferenceId = &v + return s +} + +// SetServiceType sets the ServiceType field's value. +func (s *SopRecommendation) SetServiceType(v string) *SopRecommendation { + s.ServiceType = &v + return s +} + +type StartAppAssessmentInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // The version of the application. + // + // AppVersion is a required field + AppVersion *string `locationName:"appVersion" type:"string" required:"true"` + + // The name for the assessment. + // + // AssessmentName is a required field + AssessmentName *string `locationName:"assessmentName" type:"string" required:"true"` + + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client + // token for other API requests. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartAppAssessmentInput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" min:"1" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartAppAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartAppAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartAppAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartAppAssessmentInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + if s.AppVersion == nil { + invalidParams.Add(request.NewErrParamRequired("AppVersion")) + } + if s.AssessmentName == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentName")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *StartAppAssessmentInput) SetAppArn(v string) *StartAppAssessmentInput { + s.AppArn = &v + return s +} + +// SetAppVersion sets the AppVersion field's value. +func (s *StartAppAssessmentInput) SetAppVersion(v string) *StartAppAssessmentInput { + s.AppVersion = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *StartAppAssessmentInput) SetAssessmentName(v string) *StartAppAssessmentInput { + s.AssessmentName = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartAppAssessmentInput) SetClientToken(v string) *StartAppAssessmentInput { + s.ClientToken = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *StartAppAssessmentInput) SetTags(v map[string]*string) *StartAppAssessmentInput { + s.Tags = v + return s +} + +type StartAppAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The assessment created. + // + // Assessment is a required field + Assessment *AppAssessment `locationName:"assessment" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartAppAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartAppAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *StartAppAssessmentOutput) SetAssessment(v *AppAssessment) *StartAppAssessmentOutput { + s.Assessment = v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // The tags to assign to the resource. Each tag consists of a key/value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by TagResourceInput's + // String and GoString methods. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + 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. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// Defines a test recommendation. +type TestRecommendation struct { + _ struct{} `type:"structure"` + + // The name of the application component. + AppComponentName *string `locationName:"appComponentName" type:"string"` + + // The description for the test recommendation. + Description *string `locationName:"description" min:"1" type:"string"` + + // The intent of the test recommendation. + Intent *string `locationName:"intent" type:"string"` + + // The test recommendation items. + Items []*RecommendationItem `locationName:"items" type:"list"` + + // The name of the test recommendation. + Name *string `locationName:"name" min:"1" type:"string"` + + // The prerequisite of the test recommendation. + Prerequisite *string `locationName:"prerequisite" min:"1" type:"string"` + + // Identifier for the test recommendation. + RecommendationId *string `locationName:"recommendationId" type:"string"` + + // The reference identifier for the test recommendation. + // + // ReferenceId is a required field + ReferenceId *string `locationName:"referenceId" min:"1" type:"string" required:"true"` + + // The level of risk for this test recommendation. + Risk *string `locationName:"risk" type:"string" enum:"TestRisk"` + + // The type of test recommendation. + Type *string `locationName:"type" type:"string" enum:"TestType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TestRecommendation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TestRecommendation) GoString() string { + return s.String() +} + +// SetAppComponentName sets the AppComponentName field's value. +func (s *TestRecommendation) SetAppComponentName(v string) *TestRecommendation { + s.AppComponentName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *TestRecommendation) SetDescription(v string) *TestRecommendation { + s.Description = &v + return s +} + +// SetIntent sets the Intent field's value. +func (s *TestRecommendation) SetIntent(v string) *TestRecommendation { + s.Intent = &v + return s +} + +// SetItems sets the Items field's value. +func (s *TestRecommendation) SetItems(v []*RecommendationItem) *TestRecommendation { + s.Items = v + return s +} + +// SetName sets the Name field's value. +func (s *TestRecommendation) SetName(v string) *TestRecommendation { + s.Name = &v + return s +} + +// SetPrerequisite sets the Prerequisite field's value. +func (s *TestRecommendation) SetPrerequisite(v string) *TestRecommendation { + s.Prerequisite = &v + return s +} + +// SetRecommendationId sets the RecommendationId field's value. +func (s *TestRecommendation) SetRecommendationId(v string) *TestRecommendation { + s.RecommendationId = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *TestRecommendation) SetReferenceId(v string) *TestRecommendation { + s.ReferenceId = &v + return s +} + +// SetRisk sets the Risk field's value. +func (s *TestRecommendation) SetRisk(v string) *TestRecommendation { + s.Risk = &v + return s +} + +// SetType sets the Type field's value. +func (s *TestRecommendation) SetType(v string) *TestRecommendation { + s.Type = &v + return s +} + +// The limit on the number of requests per second was exceeded. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` + + // The number of seconds to wait before retrying the operation. + RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 +} + +// Defines a resource that is not supported by Resilience Hub. +type UnsupportedResource struct { + _ struct{} `type:"structure"` + + // The logical resource identifier for the unsupported resource. + // + // LogicalResourceId is a required field + LogicalResourceId *LogicalResourceId `locationName:"logicalResourceId" type:"structure" required:"true"` + + // The physical resource identifier for the unsupported resource. + // + // PhysicalResourceId is a required field + PhysicalResourceId *PhysicalResourceId `locationName:"physicalResourceId" type:"structure" required:"true"` + + // The type of resource. + // + // ResourceType is a required field + ResourceType *string `locationName:"resourceType" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnsupportedResource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnsupportedResource) GoString() string { + return s.String() +} + +// SetLogicalResourceId sets the LogicalResourceId field's value. +func (s *UnsupportedResource) SetLogicalResourceId(v *LogicalResourceId) *UnsupportedResource { + s.LogicalResourceId = v + return s +} + +// SetPhysicalResourceId sets the PhysicalResourceId field's value. +func (s *UnsupportedResource) SetPhysicalResourceId(v *PhysicalResourceId) *UnsupportedResource { + s.PhysicalResourceId = v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *UnsupportedResource) SetResourceType(v string) *UnsupportedResource { + s.ResourceType = &v + return s +} + +type UntagResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // The keys of the tags to remove. + // + // TagKeys is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UntagResourceInput's + // String and GoString methods. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + 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. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateAppInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is: arn:partition:dcps:region:account:app/app-id. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // AppArn is a required field + AppArn *string `locationName:"appArn" type:"string" required:"true"` + + // Specifies if the resiliency policy ARN should be cleared. + ClearResiliencyPolicyArn *bool `locationName:"clearResiliencyPolicyArn" type:"boolean"` + + // The optional description for an app. + Description *string `locationName:"description" type:"string"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + PolicyArn *string `locationName:"policyArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAppInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAppInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAppInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAppInput"} + if s.AppArn == nil { + invalidParams.Add(request.NewErrParamRequired("AppArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppArn sets the AppArn field's value. +func (s *UpdateAppInput) SetAppArn(v string) *UpdateAppInput { + s.AppArn = &v + return s +} + +// SetClearResiliencyPolicyArn sets the ClearResiliencyPolicyArn field's value. +func (s *UpdateAppInput) SetClearResiliencyPolicyArn(v bool) *UpdateAppInput { + s.ClearResiliencyPolicyArn = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *UpdateAppInput) SetDescription(v string) *UpdateAppInput { + s.Description = &v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *UpdateAppInput) SetPolicyArn(v string) *UpdateAppInput { + s.PolicyArn = &v + return s +} + +type UpdateAppOutput struct { + _ struct{} `type:"structure"` + + // The specified application, returned as an object with details including compliance + // status, creation time, description, resiliency score, and more. + // + // App is a required field + App *App `locationName:"app" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAppOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAppOutput) GoString() string { + return s.String() +} + +// SetApp sets the App field's value. +func (s *UpdateAppOutput) SetApp(v *App) *UpdateAppOutput { + s.App = v + return s +} + +type UpdateResiliencyPolicyInput struct { + _ struct{} `type:"structure"` + + // Specifies a high-level geographical location constraint for where your resilience + // policy data can be stored. + DataLocationConstraint *string `locationName:"dataLocationConstraint" type:"string" enum:"DataLocationConstraint"` + + // The type of resiliency policy to be created, including the recovery time + // objective (RTO) and recovery point objective (RPO) in seconds. + Policy map[string]*FailurePolicy `locationName:"policy" type:"map"` + + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn:partition:dcps:region:account:resiliency-policy/policy-id. For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. + // + // PolicyArn is a required field + PolicyArn *string `locationName:"policyArn" type:"string" required:"true"` + + // The description for the policy. + PolicyDescription *string `locationName:"policyDescription" type:"string"` + + // The name of the policy + PolicyName *string `locationName:"policyName" type:"string"` + + // The tier for this resiliency policy, ranging from the highest severity (MissionCritical) + // to lowest (NonCritical). + Tier *string `locationName:"tier" type:"string" enum:"ResiliencyPolicyTier"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateResiliencyPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateResiliencyPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateResiliencyPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateResiliencyPolicyInput"} + if s.PolicyArn == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyArn")) + } + if s.Policy != nil { + for i, v := range s.Policy { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Policy", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataLocationConstraint sets the DataLocationConstraint field's value. +func (s *UpdateResiliencyPolicyInput) SetDataLocationConstraint(v string) *UpdateResiliencyPolicyInput { + s.DataLocationConstraint = &v + return s +} + +// SetPolicy sets the Policy field's value. +func (s *UpdateResiliencyPolicyInput) SetPolicy(v map[string]*FailurePolicy) *UpdateResiliencyPolicyInput { + s.Policy = v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *UpdateResiliencyPolicyInput) SetPolicyArn(v string) *UpdateResiliencyPolicyInput { + s.PolicyArn = &v + return s +} + +// SetPolicyDescription sets the PolicyDescription field's value. +func (s *UpdateResiliencyPolicyInput) SetPolicyDescription(v string) *UpdateResiliencyPolicyInput { + s.PolicyDescription = &v + return s +} + +// SetPolicyName sets the PolicyName field's value. +func (s *UpdateResiliencyPolicyInput) SetPolicyName(v string) *UpdateResiliencyPolicyInput { + s.PolicyName = &v + return s +} + +// SetTier sets the Tier field's value. +func (s *UpdateResiliencyPolicyInput) SetTier(v string) *UpdateResiliencyPolicyInput { + s.Tier = &v + return s +} + +type UpdateResiliencyPolicyOutput struct { + _ struct{} `type:"structure"` + + // The type of resiliency policy that was updated, including the recovery time + // objective (RTO) and recovery point objective (RPO) in seconds. + // + // Policy is a required field + Policy *ResiliencyPolicy `locationName:"policy" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateResiliencyPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateResiliencyPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicy sets the Policy field's value. +func (s *UpdateResiliencyPolicyOutput) SetPolicy(v *ResiliencyPolicy) *UpdateResiliencyPolicyOutput { + s.Policy = v + return s +} + +// Indicates that a request was not valid. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +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 +} + +const ( + // AlarmTypeMetric is a AlarmType enum value + AlarmTypeMetric = "Metric" + + // AlarmTypeComposite is a AlarmType enum value + AlarmTypeComposite = "Composite" + + // AlarmTypeCanary is a AlarmType enum value + AlarmTypeCanary = "Canary" + + // AlarmTypeLogs is a AlarmType enum value + AlarmTypeLogs = "Logs" + + // AlarmTypeEvent is a AlarmType enum value + AlarmTypeEvent = "Event" +) + +// AlarmType_Values returns all elements of the AlarmType enum +func AlarmType_Values() []string { + return []string{ + AlarmTypeMetric, + AlarmTypeComposite, + AlarmTypeCanary, + AlarmTypeLogs, + AlarmTypeEvent, + } +} + +const ( + // AppComplianceStatusTypePolicyBreached is a AppComplianceStatusType enum value + AppComplianceStatusTypePolicyBreached = "PolicyBreached" + + // AppComplianceStatusTypePolicyMet is a AppComplianceStatusType enum value + AppComplianceStatusTypePolicyMet = "PolicyMet" + + // AppComplianceStatusTypeNotAssessed is a AppComplianceStatusType enum value + AppComplianceStatusTypeNotAssessed = "NotAssessed" + + // AppComplianceStatusTypeChangesDetected is a AppComplianceStatusType enum value + AppComplianceStatusTypeChangesDetected = "ChangesDetected" +) + +// AppComplianceStatusType_Values returns all elements of the AppComplianceStatusType enum +func AppComplianceStatusType_Values() []string { + return []string{ + AppComplianceStatusTypePolicyBreached, + AppComplianceStatusTypePolicyMet, + AppComplianceStatusTypeNotAssessed, + AppComplianceStatusTypeChangesDetected, + } +} + +const ( + // AppStatusTypeActive is a AppStatusType enum value + AppStatusTypeActive = "Active" + + // AppStatusTypeDeleting is a AppStatusType enum value + AppStatusTypeDeleting = "Deleting" +) + +// AppStatusType_Values returns all elements of the AppStatusType enum +func AppStatusType_Values() []string { + return []string{ + AppStatusTypeActive, + AppStatusTypeDeleting, + } +} + +const ( + // AssessmentInvokerUser is a AssessmentInvoker enum value + AssessmentInvokerUser = "User" + + // AssessmentInvokerSystem is a AssessmentInvoker enum value + AssessmentInvokerSystem = "System" +) + +// AssessmentInvoker_Values returns all elements of the AssessmentInvoker enum +func AssessmentInvoker_Values() []string { + return []string{ + AssessmentInvokerUser, + AssessmentInvokerSystem, + } +} + +const ( + // AssessmentStatusPending is a AssessmentStatus enum value + AssessmentStatusPending = "Pending" + + // AssessmentStatusInProgress is a AssessmentStatus enum value + AssessmentStatusInProgress = "InProgress" + + // AssessmentStatusFailed is a AssessmentStatus enum value + AssessmentStatusFailed = "Failed" + + // AssessmentStatusSuccess is a AssessmentStatus enum value + AssessmentStatusSuccess = "Success" +) + +// AssessmentStatus_Values returns all elements of the AssessmentStatus enum +func AssessmentStatus_Values() []string { + return []string{ + AssessmentStatusPending, + AssessmentStatusInProgress, + AssessmentStatusFailed, + AssessmentStatusSuccess, + } +} + +const ( + // ComplianceStatusPolicyBreached is a ComplianceStatus enum value + ComplianceStatusPolicyBreached = "PolicyBreached" + + // ComplianceStatusPolicyMet is a ComplianceStatus enum value + ComplianceStatusPolicyMet = "PolicyMet" +) + +// ComplianceStatus_Values returns all elements of the ComplianceStatus enum +func ComplianceStatus_Values() []string { + return []string{ + ComplianceStatusPolicyBreached, + ComplianceStatusPolicyMet, + } +} + +const ( + // ConfigRecommendationOptimizationTypeLeastCost is a ConfigRecommendationOptimizationType enum value + ConfigRecommendationOptimizationTypeLeastCost = "LeastCost" + + // ConfigRecommendationOptimizationTypeLeastChange is a ConfigRecommendationOptimizationType enum value + ConfigRecommendationOptimizationTypeLeastChange = "LeastChange" + + // ConfigRecommendationOptimizationTypeBestAzrecovery is a ConfigRecommendationOptimizationType enum value + ConfigRecommendationOptimizationTypeBestAzrecovery = "BestAZRecovery" + + // ConfigRecommendationOptimizationTypeLeastErrors is a ConfigRecommendationOptimizationType enum value + ConfigRecommendationOptimizationTypeLeastErrors = "LeastErrors" + + // ConfigRecommendationOptimizationTypeBestAttainable is a ConfigRecommendationOptimizationType enum value + ConfigRecommendationOptimizationTypeBestAttainable = "BestAttainable" +) + +// ConfigRecommendationOptimizationType_Values returns all elements of the ConfigRecommendationOptimizationType enum +func ConfigRecommendationOptimizationType_Values() []string { + return []string{ + ConfigRecommendationOptimizationTypeLeastCost, + ConfigRecommendationOptimizationTypeLeastChange, + ConfigRecommendationOptimizationTypeBestAzrecovery, + ConfigRecommendationOptimizationTypeLeastErrors, + ConfigRecommendationOptimizationTypeBestAttainable, + } +} + +const ( + // CostFrequencyHourly is a CostFrequency enum value + CostFrequencyHourly = "Hourly" + + // CostFrequencyDaily is a CostFrequency enum value + CostFrequencyDaily = "Daily" + + // CostFrequencyMonthly is a CostFrequency enum value + CostFrequencyMonthly = "Monthly" + + // CostFrequencyYearly is a CostFrequency enum value + CostFrequencyYearly = "Yearly" +) + +// CostFrequency_Values returns all elements of the CostFrequency enum +func CostFrequency_Values() []string { + return []string{ + CostFrequencyHourly, + CostFrequencyDaily, + CostFrequencyMonthly, + CostFrequencyYearly, + } +} + +const ( + // DataLocationConstraintAnyLocation is a DataLocationConstraint enum value + DataLocationConstraintAnyLocation = "AnyLocation" + + // DataLocationConstraintSameContinent is a DataLocationConstraint enum value + DataLocationConstraintSameContinent = "SameContinent" + + // DataLocationConstraintSameCountry is a DataLocationConstraint enum value + DataLocationConstraintSameCountry = "SameCountry" +) + +// DataLocationConstraint_Values returns all elements of the DataLocationConstraint enum +func DataLocationConstraint_Values() []string { + return []string{ + DataLocationConstraintAnyLocation, + DataLocationConstraintSameContinent, + DataLocationConstraintSameCountry, + } +} + +const ( + // DisruptionTypeSoftware is a DisruptionType enum value + DisruptionTypeSoftware = "Software" + + // DisruptionTypeHardware is a DisruptionType enum value + DisruptionTypeHardware = "Hardware" + + // DisruptionTypeAz is a DisruptionType enum value + DisruptionTypeAz = "AZ" + + // DisruptionTypeRegion is a DisruptionType enum value + DisruptionTypeRegion = "Region" +) + +// DisruptionType_Values returns all elements of the DisruptionType enum +func DisruptionType_Values() []string { + return []string{ + DisruptionTypeSoftware, + DisruptionTypeHardware, + DisruptionTypeAz, + DisruptionTypeRegion, + } +} + +const ( + // EstimatedCostTierL1 is a EstimatedCostTier enum value + EstimatedCostTierL1 = "L1" + + // EstimatedCostTierL2 is a EstimatedCostTier enum value + EstimatedCostTierL2 = "L2" + + // EstimatedCostTierL3 is a EstimatedCostTier enum value + EstimatedCostTierL3 = "L3" + + // EstimatedCostTierL4 is a EstimatedCostTier enum value + EstimatedCostTierL4 = "L4" +) + +// EstimatedCostTier_Values returns all elements of the EstimatedCostTier enum +func EstimatedCostTier_Values() []string { + return []string{ + EstimatedCostTierL1, + EstimatedCostTierL2, + EstimatedCostTierL3, + EstimatedCostTierL4, + } +} + +const ( + // HaArchitectureMultiSite is a HaArchitecture enum value + HaArchitectureMultiSite = "MultiSite" + + // HaArchitectureWarmStandby is a HaArchitecture enum value + HaArchitectureWarmStandby = "WarmStandby" + + // HaArchitecturePilotLight is a HaArchitecture enum value + HaArchitecturePilotLight = "PilotLight" + + // HaArchitectureBackupAndRestore is a HaArchitecture enum value + HaArchitectureBackupAndRestore = "BackupAndRestore" + + // HaArchitectureNoRecoveryPlan is a HaArchitecture enum value + HaArchitectureNoRecoveryPlan = "NoRecoveryPlan" +) + +// HaArchitecture_Values returns all elements of the HaArchitecture enum +func HaArchitecture_Values() []string { + return []string{ + HaArchitectureMultiSite, + HaArchitectureWarmStandby, + HaArchitecturePilotLight, + HaArchitectureBackupAndRestore, + HaArchitectureNoRecoveryPlan, + } +} + +const ( + // PhysicalIdentifierTypeArn is a PhysicalIdentifierType enum value + PhysicalIdentifierTypeArn = "Arn" + + // PhysicalIdentifierTypeNative is a PhysicalIdentifierType enum value + PhysicalIdentifierTypeNative = "Native" +) + +// PhysicalIdentifierType_Values returns all elements of the PhysicalIdentifierType enum +func PhysicalIdentifierType_Values() []string { + return []string{ + PhysicalIdentifierTypeArn, + PhysicalIdentifierTypeNative, + } +} + +const ( + // RecommendationComplianceStatusBreachedUnattainable is a RecommendationComplianceStatus enum value + RecommendationComplianceStatusBreachedUnattainable = "BreachedUnattainable" + + // RecommendationComplianceStatusBreachedCanMeet is a RecommendationComplianceStatus enum value + RecommendationComplianceStatusBreachedCanMeet = "BreachedCanMeet" + + // RecommendationComplianceStatusMetCanImprove is a RecommendationComplianceStatus enum value + RecommendationComplianceStatusMetCanImprove = "MetCanImprove" +) + +// RecommendationComplianceStatus_Values returns all elements of the RecommendationComplianceStatus enum +func RecommendationComplianceStatus_Values() []string { + return []string{ + RecommendationComplianceStatusBreachedUnattainable, + RecommendationComplianceStatusBreachedCanMeet, + RecommendationComplianceStatusMetCanImprove, + } +} + +const ( + // RecommendationTemplateStatusPending is a RecommendationTemplateStatus enum value + RecommendationTemplateStatusPending = "Pending" + + // RecommendationTemplateStatusInProgress is a RecommendationTemplateStatus enum value + RecommendationTemplateStatusInProgress = "InProgress" + + // RecommendationTemplateStatusFailed is a RecommendationTemplateStatus enum value + RecommendationTemplateStatusFailed = "Failed" + + // RecommendationTemplateStatusSuccess is a RecommendationTemplateStatus enum value + RecommendationTemplateStatusSuccess = "Success" +) + +// RecommendationTemplateStatus_Values returns all elements of the RecommendationTemplateStatus enum +func RecommendationTemplateStatus_Values() []string { + return []string{ + RecommendationTemplateStatusPending, + RecommendationTemplateStatusInProgress, + RecommendationTemplateStatusFailed, + RecommendationTemplateStatusSuccess, + } +} + +const ( + // RenderRecommendationTypeAlarm is a RenderRecommendationType enum value + RenderRecommendationTypeAlarm = "Alarm" + + // RenderRecommendationTypeSop is a RenderRecommendationType enum value + RenderRecommendationTypeSop = "Sop" + + // RenderRecommendationTypeTest is a RenderRecommendationType enum value + RenderRecommendationTypeTest = "Test" +) + +// RenderRecommendationType_Values returns all elements of the RenderRecommendationType enum +func RenderRecommendationType_Values() []string { + return []string{ + RenderRecommendationTypeAlarm, + RenderRecommendationTypeSop, + RenderRecommendationTypeTest, + } +} + +const ( + // ResiliencyPolicyTierMissionCritical is a ResiliencyPolicyTier enum value + ResiliencyPolicyTierMissionCritical = "MissionCritical" + + // ResiliencyPolicyTierCritical is a ResiliencyPolicyTier enum value + ResiliencyPolicyTierCritical = "Critical" + + // ResiliencyPolicyTierImportant is a ResiliencyPolicyTier enum value + ResiliencyPolicyTierImportant = "Important" + + // ResiliencyPolicyTierCoreServices is a ResiliencyPolicyTier enum value + ResiliencyPolicyTierCoreServices = "CoreServices" + + // ResiliencyPolicyTierNonCritical is a ResiliencyPolicyTier enum value + ResiliencyPolicyTierNonCritical = "NonCritical" +) + +// ResiliencyPolicyTier_Values returns all elements of the ResiliencyPolicyTier enum +func ResiliencyPolicyTier_Values() []string { + return []string{ + ResiliencyPolicyTierMissionCritical, + ResiliencyPolicyTierCritical, + ResiliencyPolicyTierImportant, + ResiliencyPolicyTierCoreServices, + ResiliencyPolicyTierNonCritical, + } +} + +const ( + // ResourceImportStatusTypePending is a ResourceImportStatusType enum value + ResourceImportStatusTypePending = "Pending" + + // ResourceImportStatusTypeInProgress is a ResourceImportStatusType enum value + ResourceImportStatusTypeInProgress = "InProgress" + + // ResourceImportStatusTypeFailed is a ResourceImportStatusType enum value + ResourceImportStatusTypeFailed = "Failed" + + // ResourceImportStatusTypeSuccess is a ResourceImportStatusType enum value + ResourceImportStatusTypeSuccess = "Success" +) + +// ResourceImportStatusType_Values returns all elements of the ResourceImportStatusType enum +func ResourceImportStatusType_Values() []string { + return []string{ + ResourceImportStatusTypePending, + ResourceImportStatusTypeInProgress, + ResourceImportStatusTypeFailed, + ResourceImportStatusTypeSuccess, + } +} + +const ( + // ResourceMappingTypeCfnStack is a ResourceMappingType enum value + ResourceMappingTypeCfnStack = "CfnStack" + + // ResourceMappingTypeResource is a ResourceMappingType enum value + ResourceMappingTypeResource = "Resource" + + // ResourceMappingTypeAppRegistryApp is a ResourceMappingType enum value + ResourceMappingTypeAppRegistryApp = "AppRegistryApp" + + // ResourceMappingTypeResourceGroup is a ResourceMappingType enum value + ResourceMappingTypeResourceGroup = "ResourceGroup" +) + +// ResourceMappingType_Values returns all elements of the ResourceMappingType enum +func ResourceMappingType_Values() []string { + return []string{ + ResourceMappingTypeCfnStack, + ResourceMappingTypeResource, + ResourceMappingTypeAppRegistryApp, + ResourceMappingTypeResourceGroup, + } +} + +const ( + // ResourceResolutionStatusTypePending is a ResourceResolutionStatusType enum value + ResourceResolutionStatusTypePending = "Pending" + + // ResourceResolutionStatusTypeInProgress is a ResourceResolutionStatusType enum value + ResourceResolutionStatusTypeInProgress = "InProgress" + + // ResourceResolutionStatusTypeFailed is a ResourceResolutionStatusType enum value + ResourceResolutionStatusTypeFailed = "Failed" + + // ResourceResolutionStatusTypeSuccess is a ResourceResolutionStatusType enum value + ResourceResolutionStatusTypeSuccess = "Success" +) + +// ResourceResolutionStatusType_Values returns all elements of the ResourceResolutionStatusType enum +func ResourceResolutionStatusType_Values() []string { + return []string{ + ResourceResolutionStatusTypePending, + ResourceResolutionStatusTypeInProgress, + ResourceResolutionStatusTypeFailed, + ResourceResolutionStatusTypeSuccess, + } +} + +const ( + // SopServiceTypeSsm is a SopServiceType enum value + SopServiceTypeSsm = "SSM" +) + +// SopServiceType_Values returns all elements of the SopServiceType enum +func SopServiceType_Values() []string { + return []string{ + SopServiceTypeSsm, + } +} + +const ( + // TemplateFormatCfnYaml is a TemplateFormat enum value + TemplateFormatCfnYaml = "CfnYaml" + + // TemplateFormatCfnJson is a TemplateFormat enum value + TemplateFormatCfnJson = "CfnJson" +) + +// TemplateFormat_Values returns all elements of the TemplateFormat enum +func TemplateFormat_Values() []string { + return []string{ + TemplateFormatCfnYaml, + TemplateFormatCfnJson, + } +} + +const ( + // TestRiskSmall is a TestRisk enum value + TestRiskSmall = "Small" + + // TestRiskMedium is a TestRisk enum value + TestRiskMedium = "Medium" + + // TestRiskHigh is a TestRisk enum value + TestRiskHigh = "High" +) + +// TestRisk_Values returns all elements of the TestRisk enum +func TestRisk_Values() []string { + return []string{ + TestRiskSmall, + TestRiskMedium, + TestRiskHigh, + } +} + +const ( + // TestTypeSoftware is a TestType enum value + TestTypeSoftware = "Software" + + // TestTypeHardware is a TestType enum value + TestTypeHardware = "Hardware" + + // TestTypeAz is a TestType enum value + TestTypeAz = "AZ" + + // TestTypeRegion is a TestType enum value + TestTypeRegion = "Region" +) + +// TestType_Values returns all elements of the TestType enum +func TestType_Values() []string { + return []string{ + TestTypeSoftware, + TestTypeHardware, + TestTypeAz, + TestTypeRegion, + } +} diff --git a/service/resiliencehub/doc.go b/service/resiliencehub/doc.go new file mode 100644 index 00000000000..51c64081e7b --- /dev/null +++ b/service/resiliencehub/doc.go @@ -0,0 +1,33 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package resiliencehub provides the client and types for making API +// requests to AWS Resilience Hub. +// +// AWS Resilience Hub helps you proactively prepare and protect your Amazon +// Web Services applications from disruptions. Resilience Hub offers continuous +// resiliency assessment and validation that integrates into your software development +// lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery +// time objective (RTO) and recovery point objective (RPO) targets for your +// applications are met, and resolve issues before they are released into production. +// +// See https://docs.aws.amazon.com/goto/WebAPI/resiliencehub-2020-04-30 for more information on this service. +// +// See resiliencehub package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/resiliencehub/ +// +// Using the Client +// +// To contact AWS Resilience Hub 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 Resilience Hub client ResilienceHub for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/resiliencehub/#New +package resiliencehub diff --git a/service/resiliencehub/errors.go b/service/resiliencehub/errors.go new file mode 100644 index 00000000000..e1a4e69157e --- /dev/null +++ b/service/resiliencehub/errors.go @@ -0,0 +1,70 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package resiliencehub + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // You don't have permissions to perform the requested operation. The user or + // role that is making the request must have at least one IAM permissions policy + // attached that grants the required permissions. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // Occurs when a conflict with a previous successful write is detected. This + // generally occurs when the previous write did not have time to propagate to + // the host serving the current request. A retry (with appropriate backoff logic) + // is the recommended response to this exception. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // This exception occurs when there is an internal failure in the AWS Resilience + // Hub service. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The specified resource could not be found. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // You have exceeded your service quota. To perform the requested action, remove + // some of the relevant resources, or use Service Quotas to request a service + // quota increase. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // The limit on the number of requests per second was exceeded. + ErrCodeThrottlingException = "ThrottlingException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // Indicates that a request was not valid. + 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/resiliencehub/resiliencehubiface/interface.go b/service/resiliencehub/resiliencehubiface/interface.go new file mode 100644 index 00000000000..f817c670db8 --- /dev/null +++ b/service/resiliencehub/resiliencehubiface/interface.go @@ -0,0 +1,262 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package resiliencehubiface provides an interface to enable mocking the AWS Resilience Hub 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 resiliencehubiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/resiliencehub" +) + +// ResilienceHubAPI provides an interface to enable mocking the +// resiliencehub.ResilienceHub 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 Resilience Hub. +// func myFunc(svc resiliencehubiface.ResilienceHubAPI) bool { +// // Make svc.AddDraftAppVersionResourceMappings request +// } +// +// func main() { +// sess := session.New() +// svc := resiliencehub.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockResilienceHubClient struct { +// resiliencehubiface.ResilienceHubAPI +// } +// func (m *mockResilienceHubClient) AddDraftAppVersionResourceMappings(input *resiliencehub.AddDraftAppVersionResourceMappingsInput) (*resiliencehub.AddDraftAppVersionResourceMappingsOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockResilienceHubClient{} +// +// 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 ResilienceHubAPI interface { + AddDraftAppVersionResourceMappings(*resiliencehub.AddDraftAppVersionResourceMappingsInput) (*resiliencehub.AddDraftAppVersionResourceMappingsOutput, error) + AddDraftAppVersionResourceMappingsWithContext(aws.Context, *resiliencehub.AddDraftAppVersionResourceMappingsInput, ...request.Option) (*resiliencehub.AddDraftAppVersionResourceMappingsOutput, error) + AddDraftAppVersionResourceMappingsRequest(*resiliencehub.AddDraftAppVersionResourceMappingsInput) (*request.Request, *resiliencehub.AddDraftAppVersionResourceMappingsOutput) + + CreateApp(*resiliencehub.CreateAppInput) (*resiliencehub.CreateAppOutput, error) + CreateAppWithContext(aws.Context, *resiliencehub.CreateAppInput, ...request.Option) (*resiliencehub.CreateAppOutput, error) + CreateAppRequest(*resiliencehub.CreateAppInput) (*request.Request, *resiliencehub.CreateAppOutput) + + CreateRecommendationTemplate(*resiliencehub.CreateRecommendationTemplateInput) (*resiliencehub.CreateRecommendationTemplateOutput, error) + CreateRecommendationTemplateWithContext(aws.Context, *resiliencehub.CreateRecommendationTemplateInput, ...request.Option) (*resiliencehub.CreateRecommendationTemplateOutput, error) + CreateRecommendationTemplateRequest(*resiliencehub.CreateRecommendationTemplateInput) (*request.Request, *resiliencehub.CreateRecommendationTemplateOutput) + + CreateResiliencyPolicy(*resiliencehub.CreateResiliencyPolicyInput) (*resiliencehub.CreateResiliencyPolicyOutput, error) + CreateResiliencyPolicyWithContext(aws.Context, *resiliencehub.CreateResiliencyPolicyInput, ...request.Option) (*resiliencehub.CreateResiliencyPolicyOutput, error) + CreateResiliencyPolicyRequest(*resiliencehub.CreateResiliencyPolicyInput) (*request.Request, *resiliencehub.CreateResiliencyPolicyOutput) + + DeleteApp(*resiliencehub.DeleteAppInput) (*resiliencehub.DeleteAppOutput, error) + DeleteAppWithContext(aws.Context, *resiliencehub.DeleteAppInput, ...request.Option) (*resiliencehub.DeleteAppOutput, error) + DeleteAppRequest(*resiliencehub.DeleteAppInput) (*request.Request, *resiliencehub.DeleteAppOutput) + + DeleteAppAssessment(*resiliencehub.DeleteAppAssessmentInput) (*resiliencehub.DeleteAppAssessmentOutput, error) + DeleteAppAssessmentWithContext(aws.Context, *resiliencehub.DeleteAppAssessmentInput, ...request.Option) (*resiliencehub.DeleteAppAssessmentOutput, error) + DeleteAppAssessmentRequest(*resiliencehub.DeleteAppAssessmentInput) (*request.Request, *resiliencehub.DeleteAppAssessmentOutput) + + DeleteRecommendationTemplate(*resiliencehub.DeleteRecommendationTemplateInput) (*resiliencehub.DeleteRecommendationTemplateOutput, error) + DeleteRecommendationTemplateWithContext(aws.Context, *resiliencehub.DeleteRecommendationTemplateInput, ...request.Option) (*resiliencehub.DeleteRecommendationTemplateOutput, error) + DeleteRecommendationTemplateRequest(*resiliencehub.DeleteRecommendationTemplateInput) (*request.Request, *resiliencehub.DeleteRecommendationTemplateOutput) + + DeleteResiliencyPolicy(*resiliencehub.DeleteResiliencyPolicyInput) (*resiliencehub.DeleteResiliencyPolicyOutput, error) + DeleteResiliencyPolicyWithContext(aws.Context, *resiliencehub.DeleteResiliencyPolicyInput, ...request.Option) (*resiliencehub.DeleteResiliencyPolicyOutput, error) + DeleteResiliencyPolicyRequest(*resiliencehub.DeleteResiliencyPolicyInput) (*request.Request, *resiliencehub.DeleteResiliencyPolicyOutput) + + DescribeApp(*resiliencehub.DescribeAppInput) (*resiliencehub.DescribeAppOutput, error) + DescribeAppWithContext(aws.Context, *resiliencehub.DescribeAppInput, ...request.Option) (*resiliencehub.DescribeAppOutput, error) + DescribeAppRequest(*resiliencehub.DescribeAppInput) (*request.Request, *resiliencehub.DescribeAppOutput) + + DescribeAppAssessment(*resiliencehub.DescribeAppAssessmentInput) (*resiliencehub.DescribeAppAssessmentOutput, error) + DescribeAppAssessmentWithContext(aws.Context, *resiliencehub.DescribeAppAssessmentInput, ...request.Option) (*resiliencehub.DescribeAppAssessmentOutput, error) + DescribeAppAssessmentRequest(*resiliencehub.DescribeAppAssessmentInput) (*request.Request, *resiliencehub.DescribeAppAssessmentOutput) + + DescribeAppVersionResourcesResolutionStatus(*resiliencehub.DescribeAppVersionResourcesResolutionStatusInput) (*resiliencehub.DescribeAppVersionResourcesResolutionStatusOutput, error) + DescribeAppVersionResourcesResolutionStatusWithContext(aws.Context, *resiliencehub.DescribeAppVersionResourcesResolutionStatusInput, ...request.Option) (*resiliencehub.DescribeAppVersionResourcesResolutionStatusOutput, error) + DescribeAppVersionResourcesResolutionStatusRequest(*resiliencehub.DescribeAppVersionResourcesResolutionStatusInput) (*request.Request, *resiliencehub.DescribeAppVersionResourcesResolutionStatusOutput) + + DescribeAppVersionTemplate(*resiliencehub.DescribeAppVersionTemplateInput) (*resiliencehub.DescribeAppVersionTemplateOutput, error) + DescribeAppVersionTemplateWithContext(aws.Context, *resiliencehub.DescribeAppVersionTemplateInput, ...request.Option) (*resiliencehub.DescribeAppVersionTemplateOutput, error) + DescribeAppVersionTemplateRequest(*resiliencehub.DescribeAppVersionTemplateInput) (*request.Request, *resiliencehub.DescribeAppVersionTemplateOutput) + + DescribeDraftAppVersionResourcesImportStatus(*resiliencehub.DescribeDraftAppVersionResourcesImportStatusInput) (*resiliencehub.DescribeDraftAppVersionResourcesImportStatusOutput, error) + DescribeDraftAppVersionResourcesImportStatusWithContext(aws.Context, *resiliencehub.DescribeDraftAppVersionResourcesImportStatusInput, ...request.Option) (*resiliencehub.DescribeDraftAppVersionResourcesImportStatusOutput, error) + DescribeDraftAppVersionResourcesImportStatusRequest(*resiliencehub.DescribeDraftAppVersionResourcesImportStatusInput) (*request.Request, *resiliencehub.DescribeDraftAppVersionResourcesImportStatusOutput) + + DescribeResiliencyPolicy(*resiliencehub.DescribeResiliencyPolicyInput) (*resiliencehub.DescribeResiliencyPolicyOutput, error) + DescribeResiliencyPolicyWithContext(aws.Context, *resiliencehub.DescribeResiliencyPolicyInput, ...request.Option) (*resiliencehub.DescribeResiliencyPolicyOutput, error) + DescribeResiliencyPolicyRequest(*resiliencehub.DescribeResiliencyPolicyInput) (*request.Request, *resiliencehub.DescribeResiliencyPolicyOutput) + + ImportResourcesToDraftAppVersion(*resiliencehub.ImportResourcesToDraftAppVersionInput) (*resiliencehub.ImportResourcesToDraftAppVersionOutput, error) + ImportResourcesToDraftAppVersionWithContext(aws.Context, *resiliencehub.ImportResourcesToDraftAppVersionInput, ...request.Option) (*resiliencehub.ImportResourcesToDraftAppVersionOutput, error) + ImportResourcesToDraftAppVersionRequest(*resiliencehub.ImportResourcesToDraftAppVersionInput) (*request.Request, *resiliencehub.ImportResourcesToDraftAppVersionOutput) + + ListAlarmRecommendations(*resiliencehub.ListAlarmRecommendationsInput) (*resiliencehub.ListAlarmRecommendationsOutput, error) + ListAlarmRecommendationsWithContext(aws.Context, *resiliencehub.ListAlarmRecommendationsInput, ...request.Option) (*resiliencehub.ListAlarmRecommendationsOutput, error) + ListAlarmRecommendationsRequest(*resiliencehub.ListAlarmRecommendationsInput) (*request.Request, *resiliencehub.ListAlarmRecommendationsOutput) + + ListAlarmRecommendationsPages(*resiliencehub.ListAlarmRecommendationsInput, func(*resiliencehub.ListAlarmRecommendationsOutput, bool) bool) error + ListAlarmRecommendationsPagesWithContext(aws.Context, *resiliencehub.ListAlarmRecommendationsInput, func(*resiliencehub.ListAlarmRecommendationsOutput, bool) bool, ...request.Option) error + + ListAppAssessments(*resiliencehub.ListAppAssessmentsInput) (*resiliencehub.ListAppAssessmentsOutput, error) + ListAppAssessmentsWithContext(aws.Context, *resiliencehub.ListAppAssessmentsInput, ...request.Option) (*resiliencehub.ListAppAssessmentsOutput, error) + ListAppAssessmentsRequest(*resiliencehub.ListAppAssessmentsInput) (*request.Request, *resiliencehub.ListAppAssessmentsOutput) + + ListAppAssessmentsPages(*resiliencehub.ListAppAssessmentsInput, func(*resiliencehub.ListAppAssessmentsOutput, bool) bool) error + ListAppAssessmentsPagesWithContext(aws.Context, *resiliencehub.ListAppAssessmentsInput, func(*resiliencehub.ListAppAssessmentsOutput, bool) bool, ...request.Option) error + + ListAppComponentCompliances(*resiliencehub.ListAppComponentCompliancesInput) (*resiliencehub.ListAppComponentCompliancesOutput, error) + ListAppComponentCompliancesWithContext(aws.Context, *resiliencehub.ListAppComponentCompliancesInput, ...request.Option) (*resiliencehub.ListAppComponentCompliancesOutput, error) + ListAppComponentCompliancesRequest(*resiliencehub.ListAppComponentCompliancesInput) (*request.Request, *resiliencehub.ListAppComponentCompliancesOutput) + + ListAppComponentCompliancesPages(*resiliencehub.ListAppComponentCompliancesInput, func(*resiliencehub.ListAppComponentCompliancesOutput, bool) bool) error + ListAppComponentCompliancesPagesWithContext(aws.Context, *resiliencehub.ListAppComponentCompliancesInput, func(*resiliencehub.ListAppComponentCompliancesOutput, bool) bool, ...request.Option) error + + ListAppComponentRecommendations(*resiliencehub.ListAppComponentRecommendationsInput) (*resiliencehub.ListAppComponentRecommendationsOutput, error) + ListAppComponentRecommendationsWithContext(aws.Context, *resiliencehub.ListAppComponentRecommendationsInput, ...request.Option) (*resiliencehub.ListAppComponentRecommendationsOutput, error) + ListAppComponentRecommendationsRequest(*resiliencehub.ListAppComponentRecommendationsInput) (*request.Request, *resiliencehub.ListAppComponentRecommendationsOutput) + + ListAppComponentRecommendationsPages(*resiliencehub.ListAppComponentRecommendationsInput, func(*resiliencehub.ListAppComponentRecommendationsOutput, bool) bool) error + ListAppComponentRecommendationsPagesWithContext(aws.Context, *resiliencehub.ListAppComponentRecommendationsInput, func(*resiliencehub.ListAppComponentRecommendationsOutput, bool) bool, ...request.Option) error + + ListAppVersionResourceMappings(*resiliencehub.ListAppVersionResourceMappingsInput) (*resiliencehub.ListAppVersionResourceMappingsOutput, error) + ListAppVersionResourceMappingsWithContext(aws.Context, *resiliencehub.ListAppVersionResourceMappingsInput, ...request.Option) (*resiliencehub.ListAppVersionResourceMappingsOutput, error) + ListAppVersionResourceMappingsRequest(*resiliencehub.ListAppVersionResourceMappingsInput) (*request.Request, *resiliencehub.ListAppVersionResourceMappingsOutput) + + ListAppVersionResourceMappingsPages(*resiliencehub.ListAppVersionResourceMappingsInput, func(*resiliencehub.ListAppVersionResourceMappingsOutput, bool) bool) error + ListAppVersionResourceMappingsPagesWithContext(aws.Context, *resiliencehub.ListAppVersionResourceMappingsInput, func(*resiliencehub.ListAppVersionResourceMappingsOutput, bool) bool, ...request.Option) error + + ListAppVersionResources(*resiliencehub.ListAppVersionResourcesInput) (*resiliencehub.ListAppVersionResourcesOutput, error) + ListAppVersionResourcesWithContext(aws.Context, *resiliencehub.ListAppVersionResourcesInput, ...request.Option) (*resiliencehub.ListAppVersionResourcesOutput, error) + ListAppVersionResourcesRequest(*resiliencehub.ListAppVersionResourcesInput) (*request.Request, *resiliencehub.ListAppVersionResourcesOutput) + + ListAppVersionResourcesPages(*resiliencehub.ListAppVersionResourcesInput, func(*resiliencehub.ListAppVersionResourcesOutput, bool) bool) error + ListAppVersionResourcesPagesWithContext(aws.Context, *resiliencehub.ListAppVersionResourcesInput, func(*resiliencehub.ListAppVersionResourcesOutput, bool) bool, ...request.Option) error + + ListAppVersions(*resiliencehub.ListAppVersionsInput) (*resiliencehub.ListAppVersionsOutput, error) + ListAppVersionsWithContext(aws.Context, *resiliencehub.ListAppVersionsInput, ...request.Option) (*resiliencehub.ListAppVersionsOutput, error) + ListAppVersionsRequest(*resiliencehub.ListAppVersionsInput) (*request.Request, *resiliencehub.ListAppVersionsOutput) + + ListAppVersionsPages(*resiliencehub.ListAppVersionsInput, func(*resiliencehub.ListAppVersionsOutput, bool) bool) error + ListAppVersionsPagesWithContext(aws.Context, *resiliencehub.ListAppVersionsInput, func(*resiliencehub.ListAppVersionsOutput, bool) bool, ...request.Option) error + + ListApps(*resiliencehub.ListAppsInput) (*resiliencehub.ListAppsOutput, error) + ListAppsWithContext(aws.Context, *resiliencehub.ListAppsInput, ...request.Option) (*resiliencehub.ListAppsOutput, error) + ListAppsRequest(*resiliencehub.ListAppsInput) (*request.Request, *resiliencehub.ListAppsOutput) + + ListAppsPages(*resiliencehub.ListAppsInput, func(*resiliencehub.ListAppsOutput, bool) bool) error + ListAppsPagesWithContext(aws.Context, *resiliencehub.ListAppsInput, func(*resiliencehub.ListAppsOutput, bool) bool, ...request.Option) error + + ListRecommendationTemplates(*resiliencehub.ListRecommendationTemplatesInput) (*resiliencehub.ListRecommendationTemplatesOutput, error) + ListRecommendationTemplatesWithContext(aws.Context, *resiliencehub.ListRecommendationTemplatesInput, ...request.Option) (*resiliencehub.ListRecommendationTemplatesOutput, error) + ListRecommendationTemplatesRequest(*resiliencehub.ListRecommendationTemplatesInput) (*request.Request, *resiliencehub.ListRecommendationTemplatesOutput) + + ListRecommendationTemplatesPages(*resiliencehub.ListRecommendationTemplatesInput, func(*resiliencehub.ListRecommendationTemplatesOutput, bool) bool) error + ListRecommendationTemplatesPagesWithContext(aws.Context, *resiliencehub.ListRecommendationTemplatesInput, func(*resiliencehub.ListRecommendationTemplatesOutput, bool) bool, ...request.Option) error + + ListResiliencyPolicies(*resiliencehub.ListResiliencyPoliciesInput) (*resiliencehub.ListResiliencyPoliciesOutput, error) + ListResiliencyPoliciesWithContext(aws.Context, *resiliencehub.ListResiliencyPoliciesInput, ...request.Option) (*resiliencehub.ListResiliencyPoliciesOutput, error) + ListResiliencyPoliciesRequest(*resiliencehub.ListResiliencyPoliciesInput) (*request.Request, *resiliencehub.ListResiliencyPoliciesOutput) + + ListResiliencyPoliciesPages(*resiliencehub.ListResiliencyPoliciesInput, func(*resiliencehub.ListResiliencyPoliciesOutput, bool) bool) error + ListResiliencyPoliciesPagesWithContext(aws.Context, *resiliencehub.ListResiliencyPoliciesInput, func(*resiliencehub.ListResiliencyPoliciesOutput, bool) bool, ...request.Option) error + + ListSopRecommendations(*resiliencehub.ListSopRecommendationsInput) (*resiliencehub.ListSopRecommendationsOutput, error) + ListSopRecommendationsWithContext(aws.Context, *resiliencehub.ListSopRecommendationsInput, ...request.Option) (*resiliencehub.ListSopRecommendationsOutput, error) + ListSopRecommendationsRequest(*resiliencehub.ListSopRecommendationsInput) (*request.Request, *resiliencehub.ListSopRecommendationsOutput) + + ListSopRecommendationsPages(*resiliencehub.ListSopRecommendationsInput, func(*resiliencehub.ListSopRecommendationsOutput, bool) bool) error + ListSopRecommendationsPagesWithContext(aws.Context, *resiliencehub.ListSopRecommendationsInput, func(*resiliencehub.ListSopRecommendationsOutput, bool) bool, ...request.Option) error + + ListSuggestedResiliencyPolicies(*resiliencehub.ListSuggestedResiliencyPoliciesInput) (*resiliencehub.ListSuggestedResiliencyPoliciesOutput, error) + ListSuggestedResiliencyPoliciesWithContext(aws.Context, *resiliencehub.ListSuggestedResiliencyPoliciesInput, ...request.Option) (*resiliencehub.ListSuggestedResiliencyPoliciesOutput, error) + ListSuggestedResiliencyPoliciesRequest(*resiliencehub.ListSuggestedResiliencyPoliciesInput) (*request.Request, *resiliencehub.ListSuggestedResiliencyPoliciesOutput) + + ListSuggestedResiliencyPoliciesPages(*resiliencehub.ListSuggestedResiliencyPoliciesInput, func(*resiliencehub.ListSuggestedResiliencyPoliciesOutput, bool) bool) error + ListSuggestedResiliencyPoliciesPagesWithContext(aws.Context, *resiliencehub.ListSuggestedResiliencyPoliciesInput, func(*resiliencehub.ListSuggestedResiliencyPoliciesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*resiliencehub.ListTagsForResourceInput) (*resiliencehub.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *resiliencehub.ListTagsForResourceInput, ...request.Option) (*resiliencehub.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*resiliencehub.ListTagsForResourceInput) (*request.Request, *resiliencehub.ListTagsForResourceOutput) + + ListTestRecommendations(*resiliencehub.ListTestRecommendationsInput) (*resiliencehub.ListTestRecommendationsOutput, error) + ListTestRecommendationsWithContext(aws.Context, *resiliencehub.ListTestRecommendationsInput, ...request.Option) (*resiliencehub.ListTestRecommendationsOutput, error) + ListTestRecommendationsRequest(*resiliencehub.ListTestRecommendationsInput) (*request.Request, *resiliencehub.ListTestRecommendationsOutput) + + ListTestRecommendationsPages(*resiliencehub.ListTestRecommendationsInput, func(*resiliencehub.ListTestRecommendationsOutput, bool) bool) error + ListTestRecommendationsPagesWithContext(aws.Context, *resiliencehub.ListTestRecommendationsInput, func(*resiliencehub.ListTestRecommendationsOutput, bool) bool, ...request.Option) error + + ListUnsupportedAppVersionResources(*resiliencehub.ListUnsupportedAppVersionResourcesInput) (*resiliencehub.ListUnsupportedAppVersionResourcesOutput, error) + ListUnsupportedAppVersionResourcesWithContext(aws.Context, *resiliencehub.ListUnsupportedAppVersionResourcesInput, ...request.Option) (*resiliencehub.ListUnsupportedAppVersionResourcesOutput, error) + ListUnsupportedAppVersionResourcesRequest(*resiliencehub.ListUnsupportedAppVersionResourcesInput) (*request.Request, *resiliencehub.ListUnsupportedAppVersionResourcesOutput) + + ListUnsupportedAppVersionResourcesPages(*resiliencehub.ListUnsupportedAppVersionResourcesInput, func(*resiliencehub.ListUnsupportedAppVersionResourcesOutput, bool) bool) error + ListUnsupportedAppVersionResourcesPagesWithContext(aws.Context, *resiliencehub.ListUnsupportedAppVersionResourcesInput, func(*resiliencehub.ListUnsupportedAppVersionResourcesOutput, bool) bool, ...request.Option) error + + PublishAppVersion(*resiliencehub.PublishAppVersionInput) (*resiliencehub.PublishAppVersionOutput, error) + PublishAppVersionWithContext(aws.Context, *resiliencehub.PublishAppVersionInput, ...request.Option) (*resiliencehub.PublishAppVersionOutput, error) + PublishAppVersionRequest(*resiliencehub.PublishAppVersionInput) (*request.Request, *resiliencehub.PublishAppVersionOutput) + + PutDraftAppVersionTemplate(*resiliencehub.PutDraftAppVersionTemplateInput) (*resiliencehub.PutDraftAppVersionTemplateOutput, error) + PutDraftAppVersionTemplateWithContext(aws.Context, *resiliencehub.PutDraftAppVersionTemplateInput, ...request.Option) (*resiliencehub.PutDraftAppVersionTemplateOutput, error) + PutDraftAppVersionTemplateRequest(*resiliencehub.PutDraftAppVersionTemplateInput) (*request.Request, *resiliencehub.PutDraftAppVersionTemplateOutput) + + RemoveDraftAppVersionResourceMappings(*resiliencehub.RemoveDraftAppVersionResourceMappingsInput) (*resiliencehub.RemoveDraftAppVersionResourceMappingsOutput, error) + RemoveDraftAppVersionResourceMappingsWithContext(aws.Context, *resiliencehub.RemoveDraftAppVersionResourceMappingsInput, ...request.Option) (*resiliencehub.RemoveDraftAppVersionResourceMappingsOutput, error) + RemoveDraftAppVersionResourceMappingsRequest(*resiliencehub.RemoveDraftAppVersionResourceMappingsInput) (*request.Request, *resiliencehub.RemoveDraftAppVersionResourceMappingsOutput) + + ResolveAppVersionResources(*resiliencehub.ResolveAppVersionResourcesInput) (*resiliencehub.ResolveAppVersionResourcesOutput, error) + ResolveAppVersionResourcesWithContext(aws.Context, *resiliencehub.ResolveAppVersionResourcesInput, ...request.Option) (*resiliencehub.ResolveAppVersionResourcesOutput, error) + ResolveAppVersionResourcesRequest(*resiliencehub.ResolveAppVersionResourcesInput) (*request.Request, *resiliencehub.ResolveAppVersionResourcesOutput) + + StartAppAssessment(*resiliencehub.StartAppAssessmentInput) (*resiliencehub.StartAppAssessmentOutput, error) + StartAppAssessmentWithContext(aws.Context, *resiliencehub.StartAppAssessmentInput, ...request.Option) (*resiliencehub.StartAppAssessmentOutput, error) + StartAppAssessmentRequest(*resiliencehub.StartAppAssessmentInput) (*request.Request, *resiliencehub.StartAppAssessmentOutput) + + TagResource(*resiliencehub.TagResourceInput) (*resiliencehub.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *resiliencehub.TagResourceInput, ...request.Option) (*resiliencehub.TagResourceOutput, error) + TagResourceRequest(*resiliencehub.TagResourceInput) (*request.Request, *resiliencehub.TagResourceOutput) + + UntagResource(*resiliencehub.UntagResourceInput) (*resiliencehub.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *resiliencehub.UntagResourceInput, ...request.Option) (*resiliencehub.UntagResourceOutput, error) + UntagResourceRequest(*resiliencehub.UntagResourceInput) (*request.Request, *resiliencehub.UntagResourceOutput) + + UpdateApp(*resiliencehub.UpdateAppInput) (*resiliencehub.UpdateAppOutput, error) + UpdateAppWithContext(aws.Context, *resiliencehub.UpdateAppInput, ...request.Option) (*resiliencehub.UpdateAppOutput, error) + UpdateAppRequest(*resiliencehub.UpdateAppInput) (*request.Request, *resiliencehub.UpdateAppOutput) + + UpdateResiliencyPolicy(*resiliencehub.UpdateResiliencyPolicyInput) (*resiliencehub.UpdateResiliencyPolicyOutput, error) + UpdateResiliencyPolicyWithContext(aws.Context, *resiliencehub.UpdateResiliencyPolicyInput, ...request.Option) (*resiliencehub.UpdateResiliencyPolicyOutput, error) + UpdateResiliencyPolicyRequest(*resiliencehub.UpdateResiliencyPolicyInput) (*request.Request, *resiliencehub.UpdateResiliencyPolicyOutput) +} + +var _ ResilienceHubAPI = (*resiliencehub.ResilienceHub)(nil) diff --git a/service/resiliencehub/service.go b/service/resiliencehub/service.go new file mode 100644 index 00000000000..b1c828b01b7 --- /dev/null +++ b/service/resiliencehub/service.go @@ -0,0 +1,105 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package resiliencehub + +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" +) + +// ResilienceHub provides the API operation methods for making requests to +// AWS Resilience Hub. See this package's package overview docs +// for details on the service. +// +// ResilienceHub methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type ResilienceHub 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 = "resiliencehub" // Name of service. + EndpointsID = ServiceName // ID to lookup a service endpoint with. + ServiceID = "resiliencehub" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the ResilienceHub 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 ResilienceHub client from just a session. +// svc := resiliencehub.New(mySession) +// +// // Create a ResilienceHub client with additional configuration +// svc := resiliencehub.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *ResilienceHub { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "resiliencehub" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *ResilienceHub { + svc := &ResilienceHub{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2020-04-30", + ResolvedRegion: resolvedRegion, + }, + 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 ResilienceHub operation and runs any +// custom request initialization. +func (c *ResilienceHub) 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 +}