The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
", + "service": "The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
", "operations": { "BatchCreateAttendee": "Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", "CreateAttendee": "Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", @@ -40,7 +40,7 @@ } }, "AudioFeatures": { - "base": "An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
", + "base": "An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.
", "refs": { "MeetingFeaturesConfiguration$Audio": "The configuration settings for the audio features available to a meeting.
" } @@ -70,7 +70,8 @@ "Boolean": { "base": null, "refs": { - "EngineTranscribeSettings$EnablePartialResultsStabilization": "Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
" + "EngineTranscribeSettings$EnablePartialResultsStabilization": "Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
", + "EngineTranscribeSettings$IdentifyLanguage": "Automatically identifies the language spoken in media files.
" } }, "ClientRequestToken": { @@ -250,9 +251,9 @@ "MediaRegion": { "base": null, "refs": { - "CreateMeetingRequest$MediaRegion": "The Region in which to create the meeting.
Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The Region in which to create the meeting.
", - "Meeting$MediaRegion": "The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
The Region in which to create the meeting.
Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
The Region in which to create the meeting.
Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
The configuration settings of the features available to a meeting.
", + "base": "The configuration settings of the features available to a meeting.>
", "refs": { "CreateMeetingRequest$MeetingFeatures": "Lists the audio and video features enabled for a meeting, such as echo reduction.
", "CreateMeetingWithAttendeesRequest$MeetingFeatures": "Lists the audio and video features enabled for a meeting, such as echo reduction.
", @@ -372,7 +373,8 @@ "TranscribeLanguageCode": { "base": null, "refs": { - "EngineTranscribeSettings$LanguageCode": "The language code specified for the Amazon Transcribe engine.
" + "EngineTranscribeSettings$LanguageCode": "The language code specified for the Amazon Transcribe engine.
", + "EngineTranscribeSettings$PreferredLanguage": "Language code for the preferred language.
" } }, "TranscribeLanguageModelName": { @@ -381,6 +383,12 @@ "EngineTranscribeSettings$LanguageModelName": "The name of the language model used during transcription.
" } }, + "TranscribeLanguageOptions": { + "base": null, + "refs": { + "EngineTranscribeSettings$LanguageOptions": "Language codes for the languages that you want to identify. You must provide at least 2 codes.
" + } + }, "TranscribeMedicalContentIdentificationType": { "base": null, "refs": { @@ -420,7 +428,7 @@ "TranscribePiiEntityTypes": { "base": null, "refs": { - "EngineTranscribeSettings$PiiEntityTypes": "Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.
PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.
PiiEntityTypes is an optional parameter with a default value of ALL.
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.
PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.
PiiEntityTypes is an optional parameter with a default value of ALL.
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.
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 are 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.
", @@ -32,7 +32,7 @@ "ListTaskDefinitionFamilies": "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 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. 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 turn on 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 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.
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 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 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 are 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) you can update the desired count, the deployment configuration, the network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and the task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. 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, health check grace period, enable ECS managed tags option, and propagate tags option, 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 are 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.
You must have a service-linked role when you update any of the following service properties. If you specified a custom IAM role when you created the service, Amazon ECS automatically replaces the roleARN associated with the service with the ARN of your service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.
loadBalancers,
serviceRegistries
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.
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.
", + "base": "An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes 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 @@ -159,20 +159,20 @@ "base": null, "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$enableECSManagedTags": "Specifies whether to turn on 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": "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.
", + "DeploymentCircuitBreaker$enable": "Determines whether to use the deployment circuit breaker logic for the service.
", + "DeploymentCircuitBreaker$rollback": "Determines whether to configure 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 use 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": "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": "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.
", + "RunTaskRequest$enableECSManagedTags": "Specifies whether to use 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": "Determines whether to use 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 use 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$enableECSManagedTags": "Specifies whether to use 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.
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.
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.
Determines whether to turn on 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.
Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.
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.
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 where the container is placed. Otherwise, the value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier 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 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.
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 use 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 use 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 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.
", + "CreateServiceRequest$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 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 you do not use an Elastic Load Balancing, we recomend that you use the startPeriod in the task definition healtch check parameters. For more information, see Health check.
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'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 settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
", + "base": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
", "refs": { "ClusterSettings$member": null } @@ -393,9 +394,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 overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The setting to use when creating a cluster. This parameter is used to turn on 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 overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
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.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on 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'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.
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 use 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.
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.
", + "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 configure 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.
" } @@ -841,7 +842,7 @@ "EFSTransitEncryption": { "base": null, "refs": { - "EFSVolumeConfiguration$transitEncryption": "Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
The 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 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 Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.
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.
", @@ -1223,7 +1224,7 @@ } }, "LoadBalancer": { - "base": "The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
", + "base": "The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
When you add, update, or remove a load blaancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.
We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.
A service-linked role is required for services that use multiple target groups. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.
", "refs": { "LoadBalancers$member": null } @@ -1231,10 +1232,11 @@ "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 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 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.
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. 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.
" + "TaskSet$loadBalancers": "Details on a load balancer that are used with a task set.
", + "UpdateServiceRequest$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.
When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.
You can remove existing loadBalancers by passing an empty list.
Determines whether to enable managed scaling for the capacity provider.
" + "ManagedScaling$status": "Determines whether to use managed scaling for the capacity provider.
" } }, "ManagedScalingStepSize": { @@ -1502,14 +1504,15 @@ "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.
" + "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.
", + "UpdateServiceRequest$propagateTags": "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.
Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.
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 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 use 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, 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.
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 use 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 use 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 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. 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.
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 task 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 stop tasks that don't meet the placement constraints.
Fargate tasks don't support the DAEMON scheduling strategy.
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 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.
" + "TaskSet$serviceRegistries": "The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
", + "UpdateServiceRequest$serviceRegistries": "The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.
You can remove existing serviceRegistries by passing an empty list.
The details for the service registry.
", + "base": "The details for the service registry.
Each service may be associated with one service registry. Multiple service registries for each service are not supported.
When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.
", "refs": { "ServiceRegistries$member": null } @@ -2052,7 +2056,7 @@ "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 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're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.
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. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
", @@ -2068,7 +2072,7 @@ "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 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.
", + "Session$streamUrl": "A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
", "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.
", @@ -2406,7 +2410,7 @@ "CreateTaskSetResponse$taskSet": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. A task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
Details about the task set.
", "TaskSets$member": null, - "UpdateServicePrimaryTaskSetResponse$taskSet": "Details about the task set.
", + "UpdateServicePrimaryTaskSetResponse$taskSet": "etails about the task set.
", "UpdateTaskSetResponse$taskSet": "Details about the task set.
" } }, @@ -2437,7 +2441,7 @@ "TaskStopCode": { "base": null, "refs": { - "Task$stopCode": "The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
The following are valid values:
TaskFailedToStart
EssentialContainerExited
UserInitiated
TerminationNotice
ServiceSchedulerInitiated
SpotInterruption
<p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs, use Resource Access Manager's <code>CreateResourceShare</code> API. See <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">CreateResourceShare</a> in the <i>Amazon Web Services RAM API Reference</i>.</p> Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer for the application proxy inside your account.
", - "CreateEnvironment": "Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and they are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.
", - "CreateRoute": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.
When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:
If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link.
If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
If the service has an Lambda function endpoint, then Refactor Spaces uses the API Gateway Lambda integration.
A health check is performed on the service when the route is created. If the health check fails, the route transitions to FAILED, and no traffic is sent to the service.
For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created and the target group health check is run.
The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.
Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.
If an Amazon Web Services resourceis launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.
Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.
", + "CreateEnvironment": "Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.
", + "CreateRoute": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.
When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:
If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link.
If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
If the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.
A one-time health check is performed on the service when the route is created. If the health check fails, the route transitions to FAILED, and no traffic is sent to the service.
For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created and the target group health check is run.
The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.
Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is publicly resolvable.
", + "CreateService": "Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.
If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.
Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.
", "DeleteEnvironment": "Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.
", "DeleteResourcePolicy": "Deletes the resource policy set for the environment.
", @@ -17,7 +17,7 @@ "GetRoute": "Gets an Amazon Web Services Migration Hub Refactor Spaces route.
", "GetService": "Gets an Amazon Web Services Migration Hub Refactor Spaces service.
", "ListApplications": "Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
", - "ListEnvironmentVpcs": "Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment.
", + "ListEnvironmentVpcs": "Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
", "ListEnvironments": "Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
", "ListRoutes": "Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
", "ListServices": "Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
", @@ -36,9 +36,9 @@ "base": null, "refs": { "ApplicationSummary$CreatedByAccountId": "The Amazon Web Services account ID of the application creator.
", - "ApplicationSummary$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "ApplicationSummary$OwnerAccountId": "The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
", "CreateApplicationResponse$CreatedByAccountId": "The Amazon Web Services account ID of application creator.
", - "CreateApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "CreateApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
", "CreateEnvironmentResponse$OwnerAccountId": "The Amazon Web Services account ID of environment owner.
", "CreateRouteResponse$CreatedByAccountId": "The Amazon Web Services account ID of the route creator.
", "CreateRouteResponse$OwnerAccountId": "The Amazon Web Services account ID of the route owner.
", @@ -48,7 +48,7 @@ "EnvironmentVpc$AccountId": "The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
", "ErrorResponse$AccountId": "The Amazon Web Services account ID of the resource owner.
", "GetApplicationResponse$CreatedByAccountId": "The Amazon Web Services account ID of the application creator.
", - "GetApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "GetApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
", "GetEnvironmentResponse$OwnerAccountId": "The Amazon Web Services account ID of the environment owner.
", "GetRouteResponse$CreatedByAccountId": "The Amazon Web Services account ID of the route creator.
", "GetRouteResponse$OwnerAccountId": "The Amazon Web Services account ID of the route owner.
", @@ -124,7 +124,7 @@ "DeleteApplicationRequest$ApplicationIdentifier": "The ID of the application.
", "DeleteApplicationResponse$ApplicationId": "The ID of the application.
", "DeleteRouteRequest$ApplicationIdentifier": "The ID of the application to delete the route from.
", - "DeleteRouteResponse$ApplicationId": "he ID of the application that the route belongs to.
", + "DeleteRouteResponse$ApplicationId": "The ID of the application that the route belongs to.
", "DeleteServiceRequest$ApplicationIdentifier": "Deletes a Refactor Spaces service.
The RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.
The ID of the application that the service is in.
", "GetApplicationRequest$ApplicationIdentifier": "The ID of the application.
", @@ -679,7 +679,7 @@ "ResourceArn": { "base": null, "refs": { - "ApplicationSummary$Arn": "he Amazon Resource Name (ARN) of the application.
", + "ApplicationSummary$Arn": "The Amazon Resource Name (ARN) of the application.
", "CreateApplicationResponse$Arn": "The Amazon Resource Name (ARN) of the application. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
The Amazon Resource Name (ARN) of the environment.
", "CreateRouteResponse$Arn": "The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
he current state of the route.
", + "CreateRouteResponse$State": "The current state of the route.
", "DeleteRouteResponse$State": "The current state of the route.
", "GetRouteResponse$State": "The current state of the route.
", "RouteSummary$State": "The current state of the route.
" @@ -782,7 +782,7 @@ "base": null, "refs": { "CreateRouteRequest$ServiceIdentifier": "The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.
", - "CreateRouteResponse$ServiceId": "The ID of service in which the rute iscreated. Traffic that matches this route is forwarded to this service.
", + "CreateRouteResponse$ServiceId": "The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.
", "CreateServiceResponse$ServiceId": "The unique identifier of the service.
", "DeleteRouteResponse$ServiceId": "The ID of the service that the route belongs to.
", "DeleteServiceRequest$ServiceIdentifier": "The ID of the service to delete.
", diff --git a/service/chimesdkmeetings/api.go b/service/chimesdkmeetings/api.go index b980e70656..05c8626836 100644 --- a/service/chimesdkmeetings/api.go +++ b/service/chimesdkmeetings/api.go @@ -1606,10 +1606,12 @@ type CreateMeetingInput struct { // The Region in which to create the meeting. // - // Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 - // , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 - // , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 - // , us-east-2 , us-west-1 , us-west-2 . + // Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, + // ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, + // eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, + // us-west-2. + // + // Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. // // MediaRegion is a required field MediaRegion *string `min:"2" type:"string" required:"true"` @@ -1774,6 +1776,13 @@ type CreateMeetingWithAttendeesInput struct { // The Region in which to create the meeting. // + // Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, + // ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, + // eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, + // us-west-2. + // + // Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. + // // MediaRegion is a required field MediaRegion *string `min:"2" type:"string" required:"true"` @@ -2235,14 +2244,19 @@ type EngineTranscribeSettings struct { // the partial results to change. EnablePartialResultsStabilization *bool `type:"boolean"` + // Automatically identifies the language spoken in media files. + IdentifyLanguage *bool `type:"boolean"` + // The language code specified for the Amazon Transcribe engine. - // - // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"TranscribeLanguageCode"` + LanguageCode *string `type:"string" enum:"TranscribeLanguageCode"` // The name of the language model used during transcription. LanguageModelName *string `min:"1" type:"string"` + // Language codes for the languages that you want to identify. You must provide + // at least 2 codes. + LanguageOptions *string `min:"1" type:"string"` + // The stabity level of a partial results transcription. Determines how stable // you want the transcription results to be. A higher level means the transcription // results are less likely to change. @@ -2258,6 +2272,9 @@ type EngineTranscribeSettings struct { // PiiEntityTypes is an optional parameter with a default value of ALL. PiiEntityTypes *string `min:"1" type:"string"` + // Language code for the preferred language. + PreferredLanguage *string `type:"string" enum:"TranscribeLanguageCode"` + // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, // Amazon Chime uses the meeting's Region. Region *string `type:"string" enum:"TranscribeRegion"` @@ -2293,12 +2310,12 @@ func (s EngineTranscribeSettings) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *EngineTranscribeSettings) Validate() error { invalidParams := request.ErrInvalidParams{Context: "EngineTranscribeSettings"} - if s.LanguageCode == nil { - invalidParams.Add(request.NewErrParamRequired("LanguageCode")) - } if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) } + if s.LanguageOptions != nil && len(*s.LanguageOptions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageOptions", 1)) + } if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) } @@ -2327,6 +2344,12 @@ func (s *EngineTranscribeSettings) SetEnablePartialResultsStabilization(v bool) return s } +// SetIdentifyLanguage sets the IdentifyLanguage field's value. +func (s *EngineTranscribeSettings) SetIdentifyLanguage(v bool) *EngineTranscribeSettings { + s.IdentifyLanguage = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeSettings) SetLanguageCode(v string) *EngineTranscribeSettings { s.LanguageCode = &v @@ -2339,6 +2362,12 @@ func (s *EngineTranscribeSettings) SetLanguageModelName(v string) *EngineTranscr return s } +// SetLanguageOptions sets the LanguageOptions field's value. +func (s *EngineTranscribeSettings) SetLanguageOptions(v string) *EngineTranscribeSettings { + s.LanguageOptions = &v + return s +} + // SetPartialResultsStability sets the PartialResultsStability field's value. func (s *EngineTranscribeSettings) SetPartialResultsStability(v string) *EngineTranscribeSettings { s.PartialResultsStability = &v @@ -2351,6 +2380,12 @@ func (s *EngineTranscribeSettings) SetPiiEntityTypes(v string) *EngineTranscribe return s } +// SetPreferredLanguage sets the PreferredLanguage field's value. +func (s *EngineTranscribeSettings) SetPreferredLanguage(v string) *EngineTranscribeSettings { + s.PreferredLanguage = &v + return s +} + // SetRegion sets the Region field's value. func (s *EngineTranscribeSettings) SetRegion(v string) *EngineTranscribeSettings { s.Region = &v @@ -2914,6 +2949,8 @@ type Meeting struct { // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. + // + // Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. MediaRegion *string `min:"2" type:"string"` // The features available to a meeting, such as Amazon Voice Focus. @@ -2984,7 +3021,7 @@ func (s *Meeting) SetMeetingId(v string) *Meeting { return s } -// The configuration settings of the features available to a meeting. +// The configuration settings of the features available to a meeting.> type MeetingFeaturesConfiguration struct { _ struct{} `type:"structure"` diff --git a/service/chimesdkmeetings/doc.go b/service/chimesdkmeetings/doc.go index 2e0fbdd57c..dbbb5633df 100644 --- a/service/chimesdkmeetings/doc.go +++ b/service/chimesdkmeetings/doc.go @@ -6,7 +6,7 @@ // The Amazon Chime SDK meetings APIs in this section allow software developers // to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create // and manage users, and send and receive meeting notifications. For more information -// about the meeting APIs, see Amazon Chime SDK meetings (http://amazonaws.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_meetings). +// about the meeting APIs, see Amazon Chime SDK meetings (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html). // // See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15 for more information on this service. // diff --git a/service/ecs/api.go b/service/ecs/api.go index 3d70282afd..5633784dda 100644 --- a/service/ecs/api.go +++ b/service/ecs/api.go @@ -275,8 +275,8 @@ func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Requ // // 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. +// are considered healthy if they're in the RUNNING state and are reported as +// healthy by the load balancer. // // There are two service scheduler strategies available: // @@ -3596,7 +3596,7 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // 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 +// the resource. You must turn on this setting to use Amazon ECS features such // as resource tagging. // // When awsvpcTrunking is specified, the elastic network interface (ENI) limit @@ -5465,8 +5465,7 @@ func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstanc // 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. +// are 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 @@ -5586,23 +5585,27 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // // 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 rolling update (ECS) you can update the desired count, +// the deployment configuration, the network configuration, load balancers, +// service registries, enable ECS managed tags option, propagate tags option, +// task placement constraints and strategies, and the task definition. When +// you update any of these parameters, Amazon ECS starts new tasks with the +// new configuration. // // 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 (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) +// strategies, enable ECS managed tags option, and propagate tags can be updated +// using this API. If the network configuration, platform version, task definition, +// or load balancer need to be updated, create a new CodeDeploy deployment. +// 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, create -// a new task set. For more information, see CreateTaskSet. +// the desired count, task placement constraints and strategies, health check +// grace period, enable ECS managed tags option, and propagate tags option, +// 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 @@ -5631,8 +5634,7 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // 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. +// in the RUNNING state and are 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 @@ -5676,6 +5678,17 @@ func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Requ // (based on the previous steps), favoring container instances with the largest // number of running tasks for this service. // +// You must have a service-linked role when you update any of the following +// service properties. If you specified a custom IAM role when you created the +// service, Amazon ECS automatically replaces the roleARN (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn) +// associated with the service with the ARN of your service-linked role. For +// more information, see Service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// in the Amazon Elastic Container Service Developer Guide. +// +// * loadBalancers, +// +// * serviceRegistries +// // 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. @@ -6159,8 +6172,8 @@ func (s *AttachmentStateChange) SetStatus(v string) *AttachmentStateChange { } // 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) +// Use attributes 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"` @@ -7447,8 +7460,8 @@ func (s *ClusterNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// The settings to use when creating a cluster. This parameter is used to enable -// CloudWatch Container Insights for a cluster. +// The settings to use when creating a cluster. This parameter is used to turn +// on CloudWatch Container Insights for a cluster. type ClusterSetting struct { _ struct{} `type:"structure"` @@ -7743,10 +7756,10 @@ type ContainerDefinition struct { // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // version 1.26.0 of the container agent to turn on 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 (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 @@ -8155,7 +8168,7 @@ type ContainerDefinition struct { // * 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 + // least version 1.26.0 of the container agent to use 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) @@ -8187,8 +8200,8 @@ type ContainerDefinition struct { // 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 + // of the container agent to use 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 @@ -8625,7 +8638,7 @@ func (s *ContainerDefinition) SetWorkingDirectory(v string) *ContainerDefinition // 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 +// container agent to use 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) @@ -9434,8 +9447,8 @@ type CreateClusterInput struct { // 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, + // The setting to use when creating a cluster. This parameter is used to turn + // on CloudWatch Container Insights for a cluster. If this value is specified, // it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. Settings []*ClusterSetting `locationName:"settings" type:"list"` @@ -9618,7 +9631,7 @@ type CreateServiceInput struct { // 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 + // Specifies whether to turn on Amazon ECS managed tags for the tasks within // 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. @@ -9635,6 +9648,10 @@ type CreateServiceInput struct { // 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 you do not use an Elastic Load Balancing, we recomend that you use the + // startPeriod in the task definition healtch check parameters. For more information, + // see Health check (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). + // // 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 @@ -9687,10 +9704,8 @@ type CreateServiceInput struct { // 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. + // 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 @@ -11155,21 +11170,20 @@ func (s *Deployment) SetUpdatedAt(v time.Time) *Deployment { // 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 +// configure Amazon ECS to roll back your service to the last completed deployment // after a failure. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) // in the Amazon Elastic Container Service Developer Guide. type DeploymentCircuitBreaker struct { _ struct{} `type:"structure"` - // Determines whether to enable the deployment circuit breaker logic for the - // service. + // Determines whether to use the deployment circuit breaker logic for the service. // // Enable is a required field Enable *bool `locationName:"enable" type:"boolean" required:"true"` - // 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. + // Determines whether to configure 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"` @@ -12711,7 +12725,7 @@ type EFSVolumeConfiguration struct { // the path set on the EFS access point. RootDirectory *string `locationName:"rootDirectory" type:"string"` - // Determines whether to enable encryption for Amazon EFS data in transit between + // Determines whether to use 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 @@ -12876,12 +12890,9 @@ func (s *EnvironmentFile) SetValue(v string) *EnvironmentFile { // Fargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) // 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. +// This parameter is only supported for tasks hosted on Fargate using Linux +// platform version 1.4.0 or later. This parameter is not supported for Windows +// containers on Fargate. type EphemeralStorage struct { _ struct{} `type:"structure"` @@ -13091,7 +13102,7 @@ func (s *ExecuteCommandInput) SetTask(v string) *ExecuteCommandInput { type ExecuteCommandLogConfiguration struct { _ struct{} `type:"structure"` - // Determines whether to enable encryption on the CloudWatch logs. If not specified, + // Determines whether to use encryption on the CloudWatch logs. If not specified, // encryption will be disabled. CloudWatchEncryptionEnabled *bool `locationName:"cloudWatchEncryptionEnabled" type:"boolean"` @@ -15510,6 +15521,17 @@ func (s *ListTasksOutput) SetTaskArns(v []*string) *ListTasksOutput { // // For specific notes and restrictions regarding the use of load balancers with // services and task sets, see the CreateService and CreateTaskSet actions. +// +// When you add, update, or remove a load blaancer configuration, Amazon ECS +// starts a new deployment with the updated Elastic Load Balancing configuration. +// This causes tasks to register to and deregister from load balancers. +// +// We recommend that you verify this on a test environment before you update +// the Elastic Load Balancing configuration. +// +// A service-linked role is required for services that use multiple target groups. +// For more information, see Service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// in the Amazon Elastic Container Service Developer Guide. type LoadBalancer struct { _ struct{} `type:"structure"` @@ -15906,7 +15928,7 @@ type ManagedScaling struct { // used. MinimumScalingStepSize *int64 `locationName:"minimumScalingStepSize" min:"1" type:"integer"` - // Determines whether to enable managed scaling for the capacity provider. + // Determines whether to use 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 @@ -16736,10 +16758,10 @@ func (s *PortMapping) SetProtocol(v string) *PortMapping { // // 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) +// of the ecs-init package to use 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"` @@ -17694,11 +17716,10 @@ type RegisterTaskDefinitionInput struct { // // 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 - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html) + // of the ecs-init package to use 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html) // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"` @@ -18340,12 +18361,12 @@ type RunTaskInput struct { // 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 - // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // Specifies whether to use Amazon ECS managed tags for the task. 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"` - // Determines whether to enable the execute command functionality for the containers + // Determines whether to use 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"` @@ -18794,6 +18815,13 @@ type Secret struct { // full ARN of the Secrets Manager secret or the full ARN of the parameter in // the SSM Parameter Store. // + // For information about the require Identity and Access Management permissions, + // see Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) + // (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) + // (for Systems Manager Parameter store) in the Amazon Elastic Container Service + // Developer Guide. + // // 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 @@ -18947,8 +18975,8 @@ type Service struct { // CreateService, and it can be modified with UpdateService. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` - // 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) + // Determines whether to use 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"` @@ -19026,7 +19054,7 @@ type Service struct { // 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 + // active container instance. This task 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 stop tasks that don't // meet the placement constraints. Fargate tasks don't support the DAEMON @@ -19477,6 +19505,13 @@ func (s *ServiceNotFoundException) RequestID() string { } // The details for the service registry. +// +// Each service may be associated with one service registry. Multiple service +// registries for each service are not supported. +// +// When you add, update, or remove the service registries configuration, Amazon +// ECS starts a new deployment. New tasks are registered and deregistered to +// the updated service registry configuration. type ServiceRegistry struct { _ struct{} `type:"structure"` @@ -19558,7 +19593,7 @@ type Session struct { // The ID of the execute command session. SessionId *string `locationName:"sessionId" type:"string"` - // A URL back to managed agent on the container that the SSM Session Manager + // A URL to the managed agent on the container that the SSM Session Manager // client uses to send commands and receive output from the container. StreamUrl *string `locationName:"streamUrl" type:"string"` @@ -19674,8 +19709,8 @@ type StartTaskInput struct { // ContainerInstances is a required field ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` - // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // Specifies whether to use Amazon ECS managed tags for the task. 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"` @@ -20979,6 +21014,20 @@ type Task struct { // The stop code indicating why a task was stopped. The stoppedReason might // contain additional details. + // + // The following are valid values: + // + // * TaskFailedToStart + // + // * EssentialContainerExited + // + // * UserInitiated + // + // * TerminationNotice + // + // * ServiceSchedulerInitiated + // + // * SpotInterruption StopCode *string `locationName:"stopCode" type:"string" enum:"TaskStopCode"` // The Unix timestamp for the time when the task was stopped. More specifically, @@ -21458,7 +21507,7 @@ 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 + // use 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) @@ -22755,8 +22804,8 @@ type UpdateClusterSettingsInput struct { // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` - // 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, + // The setting to use by default for a cluster. This parameter is used to turn + // on CloudWatch Container Insights for a cluster. If this value is specified, // it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. // // Settings is a required field @@ -23156,6 +23205,15 @@ type UpdateServiceInput struct { // service. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` + // Determines whether to turn on 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. + // + // Only tasks launched after the update will reflect the update. To update the + // tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts + // new tasks with the updated tags. + EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"` + // 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 @@ -23180,6 +23238,17 @@ type UpdateServiceInput struct { // stopping them before they have time to come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` + // 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. + // + // When you add, update, or remove a load balancer configuration, Amazon ECS + // starts new tasks with the updated Elastic Load Balancing configuration, and + // then stops the old tasks when the new tasks are running. + // + // You can remove existing loadBalancers by passing an empty list. + LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` + // An object representing the network configuration for the service. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` @@ -23209,11 +23278,29 @@ type UpdateServiceInput struct { // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` + // 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. + // + // Only tasks launched after the update will reflect the update. To update the + // tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts + // new tasks with the updated tags. + PropagateTags *string `locationName:"propagateTags" type:"string" enum:"PropagateTags"` + // The name of the service to update. // // Service is a required field Service *string `locationName:"service" type:"string" required:"true"` + // 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). + // + // When you add, update, or remove the service registries configuration, Amazon + // ECS starts new tasks with the updated service registries configuration, and + // then stops the old tasks when the new tasks are running. + // + // You can remove existing serviceRegistries by passing an empty list. + ServiceRegistries []*ServiceRegistry `locationName:"serviceRegistries" 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 // revision is used. If you modify the task definition with UpdateService, Amazon @@ -23297,6 +23384,12 @@ func (s *UpdateServiceInput) SetDesiredCount(v int64) *UpdateServiceInput { return s } +// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. +func (s *UpdateServiceInput) SetEnableECSManagedTags(v bool) *UpdateServiceInput { + s.EnableECSManagedTags = &v + return s +} + // SetEnableExecuteCommand sets the EnableExecuteCommand field's value. func (s *UpdateServiceInput) SetEnableExecuteCommand(v bool) *UpdateServiceInput { s.EnableExecuteCommand = &v @@ -23315,6 +23408,12 @@ func (s *UpdateServiceInput) SetHealthCheckGracePeriodSeconds(v int64) *UpdateSe return s } +// SetLoadBalancers sets the LoadBalancers field's value. +func (s *UpdateServiceInput) SetLoadBalancers(v []*LoadBalancer) *UpdateServiceInput { + s.LoadBalancers = v + return s +} + // SetNetworkConfiguration sets the NetworkConfiguration field's value. func (s *UpdateServiceInput) SetNetworkConfiguration(v *NetworkConfiguration) *UpdateServiceInput { s.NetworkConfiguration = v @@ -23339,12 +23438,24 @@ func (s *UpdateServiceInput) SetPlatformVersion(v string) *UpdateServiceInput { return s } +// SetPropagateTags sets the PropagateTags field's value. +func (s *UpdateServiceInput) SetPropagateTags(v string) *UpdateServiceInput { + s.PropagateTags = &v + return s +} + // SetService sets the Service field's value. func (s *UpdateServiceInput) SetService(v string) *UpdateServiceInput { s.Service = &v return s } +// SetServiceRegistries sets the ServiceRegistries field's value. +func (s *UpdateServiceInput) SetServiceRegistries(v []*ServiceRegistry) *UpdateServiceInput { + s.ServiceRegistries = v + return s +} + // SetTaskDefinition sets the TaskDefinition field's value. func (s *UpdateServiceInput) SetTaskDefinition(v string) *UpdateServiceInput { s.TaskDefinition = &v @@ -23462,7 +23573,7 @@ func (s *UpdateServicePrimaryTaskSetInput) SetService(v string) *UpdateServicePr type UpdateServicePrimaryTaskSetOutput struct { _ struct{} `type:"structure"` - // Details about the task set. + // etails about the task set. TaskSet *TaskSet `locationName:"taskSet" type:"structure"` } @@ -24563,6 +24674,9 @@ const ( // PropagateTagsService is a PropagateTags enum value PropagateTagsService = "SERVICE" + + // PropagateTagsNone is a PropagateTags enum value + PropagateTagsNone = "NONE" ) // PropagateTags_Values returns all elements of the PropagateTags enum @@ -24570,6 +24684,7 @@ func PropagateTags_Values() []string { return []string{ PropagateTagsTaskDefinition, PropagateTagsService, + PropagateTagsNone, } } diff --git a/service/migrationhubrefactorspaces/api.go b/service/migrationhubrefactorspaces/api.go index 29418861e1..f1f4d4dc5c 100644 --- a/service/migrationhubrefactorspaces/api.go +++ b/service/migrationhubrefactorspaces/api.go @@ -60,8 +60,8 @@ func (c *MigrationHubRefactorSpaces) CreateApplicationRequest(input *CreateAppli // Creates an Amazon Web Services Migration Hub Refactor Spaces application. // The account that owns the environment also owns the applications created // inside the environment, regardless of the account that creates the application. -// Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer -// for the application proxy inside your account. +// Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and +// Network Load Balancer for the application proxy inside your account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -159,10 +159,11 @@ func (c *MigrationHubRefactorSpaces) CreateEnvironmentRequest(input *CreateEnvir // CreateEnvironment API operation for AWS Migration Hub Refactor Spaces. // // Creates an Amazon Web Services Migration Hub Refactor Spaces environment. -// The caller owns the environment resource, and they are referred to as the -// environment owner. The environment owner has cross-account visibility and -// control of Refactor Spaces resources that are added to the environment by -// other accounts that the environment is shared with. When creating an environment, +// The caller owns the environment resource, and all Refactor Spaces applications, +// services, and routes created within the environment. They are referred to +// as the environment owner. The environment owner has cross-account visibility +// and control of Refactor Spaces resources that are added to the environment +// by other accounts that the environment is shared with. When creating an environment, // Refactor Spaces provisions a transit gateway in your account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -276,11 +277,12 @@ func (c *MigrationHubRefactorSpaces) CreateRouteRequest(input *CreateRouteInput) // IP address, Refactor Spaces routes traffic over the public internet. // // * If the service has an Lambda function endpoint, then Refactor Spaces -// uses the API Gateway Lambda integration. +// configures the Lambda function's resource policy to allow the application's +// API Gateway to invoke the function. // -// A health check is performed on the service when the route is created. If -// the health check fails, the route transitions to FAILED, and no traffic is -// sent to the service. +// A one-time health check is performed on the service when the route is created. +// If the health check fails, the route transitions to FAILED, and no traffic +// is sent to the service. // // For Lambda functions, the Lambda function state is checked. If the function // is not active, the function configuration is updated so that Lambda resources @@ -300,6 +302,10 @@ func (c *MigrationHubRefactorSpaces) CreateRouteRequest(input *CreateRouteInput) // The health check is considered successful if at least one target within the // target group transitions to a healthy state. // +// Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed +// certificates are supported. Private Certificate Authorities (CAs) are permitted +// only if the CA's domain is publicly resolvable. +// // 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. @@ -400,10 +406,10 @@ func (c *MigrationHubRefactorSpaces) CreateServiceRequest(input *CreateServiceIn // of which account in the environment creates the service. Services have either // a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. // -// If an Amazon Web Services resourceis launched in a service VPC, and you want -// it to be accessible to all of an environment’s services with VPCs and routes, -// apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to -// add more cross-account constraints, apply your own security group. +// If an Amazon Web Services resource is launched in a service VPC, and you +// want it to be accessible to all of an environment’s services with VPCs +// and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, +// to add more cross-account constraints, apply your own security group. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1589,8 +1595,8 @@ func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcsRequest(input *ListEnvir // ListEnvironmentVpcs API operation for AWS Migration Hub Refactor Spaces. // -// Lists all the virtual private clouds (VPCs) that are part of an Amazon Web -// Services Migration Hub Refactor Spaces environment. +// Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual +// private clouds (VPCs) that are part of the environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2827,7 +2833,7 @@ type ApplicationSummary struct { // The unique identifier of the application. ApplicationId *string `min:"14" type:"string"` - // he Amazon Resource Name (ARN) of the application. + // The Amazon Resource Name (ARN) of the application. Arn *string `min:"20" type:"string"` // The Amazon Web Services account ID of the application creator. @@ -2848,7 +2854,8 @@ type ApplicationSummary struct { // The name of the application. Name *string `min:"3" type:"string"` - // The Amazon Web Services account ID of the application owner. + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string `min:"12" type:"string"` // The proxy type of the proxy created within the application. @@ -3214,7 +3221,8 @@ type CreateApplicationOutput struct { // The name of the application. Name *string `min:"3" type:"string"` - // The Amazon Web Services account ID of the application owner. + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string `min:"12" type:"string"` // The proxy type of the proxy created within the application. @@ -3721,11 +3729,11 @@ type CreateRouteOutput struct { // The route type of the route. RouteType *string `type:"string" enum:"RouteType"` - // The ID of service in which the rute iscreated. Traffic that matches this + // The ID of service in which the route is created. Traffic that matches this // route is forwarded to this service. ServiceId *string `min:"14" type:"string"` - // he current state of the route. + // The current state of the route. State *string `type:"string" enum:"RouteState"` // The tags assigned to the created route. A tag is a label that you assign @@ -4593,7 +4601,7 @@ func (s *DeleteRouteInput) SetRouteIdentifier(v string) *DeleteRouteInput { type DeleteRouteOutput struct { _ struct{} `type:"structure"` - // he ID of the application that the route belongs to. + // The ID of the application that the route belongs to. ApplicationId *string `min:"14" type:"string"` // The Amazon Resource Name (ARN) of the route. @@ -5233,7 +5241,8 @@ type GetApplicationOutput struct { // The name of the application. Name *string `min:"3" type:"string"` - // The Amazon Web Services account ID of the application owner. + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string `min:"12" type:"string"` // The proxy type of the proxy created within the application. diff --git a/service/migrationhubrefactorspaces/doc.go b/service/migrationhubrefactorspaces/doc.go index acc96786ef..a1e38c8b19 100644 --- a/service/migrationhubrefactorspaces/doc.go +++ b/service/migrationhubrefactorspaces/doc.go @@ -11,6 +11,10 @@ // one of the Amazon Web Services SDKs to access an API that is tailored // to the programming language or platform that you're using. For more information, // see Amazon Web Services SDKs. +//To share Refactor Spaces environments with other Amazon Web Services
+// accounts or with Organizations and their OUs, use Resource Access Manager's
+// CreateResourceShare API. See CreateResourceShare
+// in the Amazon Web Services RAM API Reference.