2024/10/30 - Amazon EC2 Container Service - 3 new api methods
Changes This release supports service deployments and service revisions which provide a comprehensive view of your Amazon ECS service history.
This operation lists all the service deployments that meet the specified filter criteria.
A service deployment happens when you release a softwre update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks.
This API returns the values that you use for the request parameters in DescribeServiceRevisions.
See also: AWS API Documentation
Request Syntax
client.list_service_deployments(
service='string',
cluster='string',
status=[
'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
],
createdAt={
'before': datetime(2015, 1, 1),
'after': datetime(2015, 1, 1)
},
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The ARN or name of the service
string
The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performanceIf you don't specify a cluster, deault is used.
list
An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.
(string) --
dict
An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
before (datetime) --
Include service deployments in the result that were created before this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
after (datetime) --
Include service deployments in the result that were created after this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
string
The nextToken value returned from a ListServiceDeployments request indicating that more results are available to fulfill the request and further calls are needed. If you provided maxResults, it's possible the number of results is fewer than maxResults.
integer
The maximum number of service deployment results that ListServiceDeployments returned in paginated output. When this parameter is used, ListServiceDeployments 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 ListServiceDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceDeployments returns up to 20 results and a nextToken value if applicable.
dict
Response Syntax
{
'serviceDeployments': [
{
'serviceDeploymentArn': 'string',
'serviceArn': 'string',
'clusterArn': 'string',
'startedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'finishedAt': datetime(2015, 1, 1),
'targetServiceRevisionArn': 'string',
'status': 'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
'statusReason': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
serviceDeployments (list) --
An overview of the service deployment, including the following properties:
The ARN of the service deployment.
The ARN of the service being deployed.
The ARN of the cluster that hosts the service in the service deployment.
The time that the service deployment started.
The time that the service deployment completed.
The service deployment status.
Information about why the service deployment is in the current state.
The ARN of the service revision that is being deployed.
(dict) --
The service deployment properties that are retured when you call ListServiceDeployments.
This provides a high-level overview of the service deployment.
serviceDeploymentArn (string) --
The ARN of the service deployment.
serviceArn (string) --
The ARN of the service for this service deployment.
clusterArn (string) --
The ARN of the cluster that hosts the service.
startedAt (datetime) --
The time that the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
createdAt (datetime) --
The time that the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
finishedAt (datetime) --
The time that the service deployment completed. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
targetServiceRevisionArn (string) --
The ARN of the service revision being deplyed.
status (string) --
The status of the service deployment
statusReason (string) --
Information about why the service deployment is in the current status. For example, the circuit breaker detected a deployment failure.
nextToken (string) --
The nextToken value to include in a future ListServiceDeployments request. When the results of a ListServiceDeployments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Describes one or more service revisions.
A service revision is a version of the service that includes the values for the Amazon ECS resources (for example, task definition) and the environment resources (for example, load balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.
You can't describe a service revision that was created before October 25, 2024.
See also: AWS API Documentation
Request Syntax
client.describe_service_revisions(
serviceRevisionArns=[
'string',
]
)
list
[REQUIRED]
The ARN of the service revision.
You can specify a maximum of 20 ARNs.
You can call ListServiceDeployments to get the ARNs.
(string) --
dict
Response Syntax
{ 'serviceRevisions': [ { 'serviceRevisionArn': 'string', 'serviceArn': 'string', 'clusterArn': 'string', 'taskDefinition': 'string', 'capacityProviderStrategy': [ { 'capacityProvider': 'string', 'weight': 123, 'base': 123 }, ], 'launchType': 'EC2'|'FARGATE'|'EXTERNAL', 'platformVersion': 'string', 'platformFamily': 'string', 'loadBalancers': [ { 'targetGroupArn': 'string', 'loadBalancerName': 'string', 'containerName': 'string', 'containerPort': 123 }, ], 'serviceRegistries': [ { 'registryArn': 'string', 'port': 123, 'containerName': 'string', 'containerPort': 123 }, ], 'networkConfiguration': { 'awsvpcConfiguration': { 'subnets': [ 'string', ], 'securityGroups': [ 'string', ], 'assignPublicIp': 'ENABLED'|'DISABLED' } }, 'containerImages': [ { 'containerName': 'string', 'imageDigest': 'string', 'image': 'string' }, ], 'guardDutyEnabled': True|False, 'serviceConnectConfiguration': { 'enabled': True|False, 'namespace': 'string', 'services': [ { 'portName': 'string', 'discoveryName': 'string', 'clientAliases': [ { 'port': 123, 'dnsName': 'string' }, ], 'ingressPortOverride': 123, 'timeout': { 'idleTimeoutSeconds': 123, 'perRequestTimeoutSeconds': 123 }, 'tls': { 'issuerCertificateAuthority': { 'awsPcaAuthorityArn': 'string' }, 'kmsKey': 'string', 'roleArn': 'string' } }, ], 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk'|'awsfirelens', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] } }, 'volumeConfigurations': [ { 'name': 'string', 'managedEBSVolume': { 'encrypted': True|False, 'kmsKeyId': 'string', 'volumeType': 'string', 'sizeInGiB': 123, 'snapshotId': 'string', 'iops': 123, 'throughput': 123, 'tagSpecifications': [ { 'resourceType': 'volume', 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'propagateTags': 'TASK_DEFINITION'|'SERVICE'|'NONE' }, ], 'roleArn': 'string', 'filesystemType': 'ext3'|'ext4'|'xfs'|'ntfs' } }, ], 'fargateEphemeralStorage': { 'kmsKeyId': 'string' }, 'createdAt': datetime(2015, 1, 1) }, ], 'failures': [ { 'arn': 'string', 'reason': 'string', 'detail': 'string' }, ] }Response Structure
(dict) --
serviceRevisions (list) --
The list of service revisions described.
(dict) --
Information about the service revision.
A service revision contains a record of the workload configuration Amazon ECS is attempting to deploy. Whenever you create or deploy a service, Amazon ECS automatically creates and captures the configuration that you're trying to deploy in the service revision. For information about service revisions, see Amazon ECS service revisions in the Amazon Elastic Container Service Developer Guide .
serviceRevisionArn (string) --
The ARN of the service revision.
serviceArn (string) --
The ARN of the service for the service revision.
clusterArn (string) --
The ARN of the cluster that hosts the service.
taskDefinition (string) --
The task definition the service revision uses.
capacityProviderStrategy (list) --
The capacity provider strategy the service revision uses.
(dict) --
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html>`__or `CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. FARGATE_SPOT supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProvider (string) --
The short name of the capacity provider.
weight (integer) --
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
base (integer) --
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
launchType (string) --
The launch type the service revision uses.
platformVersion (string) --
For the Fargate launch type, the platform version the service revision uses.
platformFamily (string) --
The platform family the service revision uses.
loadBalancers (list) --
The load balancers the service revision uses.
(dict) --
The load balancer configuration to use with a service or task set.
When you add, update, or remove a load balancer 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 Using service-linked roles in the Amazon Elastic Container Service Developer Guide.
targetGroupArn (string) --
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
loadBalancerName (string) --
The name of the load balancer to associate with the service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
containerName (string) --
The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
containerPort (integer) --
The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the hostPort of the port mapping.
serviceRegistries (list) --
The service registries (for Service Discovery) the service revision uses.
(dict) --
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.
registryArn (string) --
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService.
port (integer) --
The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.
containerName (string) --
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.
containerPort (integer) --
The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.
networkConfiguration (dict) --
The network configuration for a task or service.
awsvpcConfiguration (dict) --
The VPC subnets and security groups that are associated with a task.
subnets (list) --
The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per awsvpcConfiguration.
(string) --
securityGroups (list) --
The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per awsvpcConfiguration.
(string) --
assignPublicIp (string) --
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
containerImages (list) --
The container images the service revision uses.
(dict) --
The details about the container image a service revision uses.
To ensure that all tasks in a service use the same container image, Amazon ECS resolves container image names and any image tags specified in the task definition to container image digests.
After the container image digest has been established, Amazon ECS uses the digest to start any other desired tasks, and for any future service and service revision updates. This leads to all tasks in a service always running identical container images, resulting in version consistency for your software. For more information, see Container image resolution in the Amazon ECS Developer Guide.
containerName (string) --
The name of the container.
imageDigest (string) --
The container image digest.
image (string) --
The container image.
guardDutyEnabled (boolean) --
Indicates whether Runtime Monitoring is turned on.
serviceConnectConfiguration (dict) --
The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
enabled (boolean) --
Specifies whether to use Service Connect with this service.
namespace (string) --
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide.
services (list) --
The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.
This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.
An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.
(dict) --
The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
portName (string) --
The portName must match the name of one of the portMappings from all the containers in the task definition of this Amazon ECS service.
discoveryName (string) --
The discoveryName is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.
If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
clientAliases (list) --
The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.
Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
For each ServiceConnectService, you must provide at least one clientAlias with one port.
(dict) --
Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.
Each name and port mapping must be unique within the namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
port (integer) --
The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
dnsName (string) --
The dnsName is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are database, db, or the lowercase name of a database, such as mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
ingressPortOverride (integer) --
The port number for the Service Connect proxy to listen on.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named portMapping in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port number. The container port number is in the portMapping in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.
timeout (dict) --
A reference to an object that represents the configured timeouts for Service Connect.
idleTimeoutSeconds (integer) --
The amount of time in seconds a connection will stay active while idle. A value of 0 can be set to disable idleTimeout.
The idleTimeout default for HTTP/ HTTP2/ GRPC is 5 minutes.
The idleTimeout default for TCP is 1 hour.
perRequestTimeoutSeconds (integer) --
The amount of time waiting for the upstream to respond with a complete response per request. A value of 0 can be set to disable perRequestTimeout. perRequestTimeout can only be set if Service Connect appProtocol isn't TCP. Only idleTimeout is allowed for TCP appProtocol.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) configuration.
issuerCertificateAuthority (dict) --
The signer certificate authority.
awsPcaAuthorityArn (string) --
The ARN of the Amazon Web Services Private Certificate Authority certificate.
kmsKey (string) --
The Amazon Web Services Key Management Service key.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.
logConfiguration (dict) --
The log configuration for the container. This parameter maps to LogConfig in the docker container create command and the --log-driver option to docker run.
By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.
Understand the following when specifying a log configuration for your containers.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, syslog, splunk, and awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
logDriver (string) --
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.
options (dict) --
The configuration options to send to the log driver.
The options you can specify depend on the log driver. Some of the options you can specify when you use the awslogs log driver to route logs to Amazon CloudWatch include the following:
awslogs-create-group
Required: No
Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to false.
Required: Yes
Specify the Amazon Web Services Region that the awslogs log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option.
awslogs-group
Required: Yes
Make sure to specify a log group that the awslogs log driver sends its log streams to.
awslogs-stream-prefix
Required: Yes, when using the Fargate launch type.Optional for the EC2 launch type, required for the Fargate launch type.
Use the awslogs-stream-prefix option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format prefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option.
For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to.
You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console.
awslogs-datetime-format
Required: No
This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry.
For more information, see awslogs-datetime-format.
You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options.
Required: No
This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.
For more information, see awslogs-multiline-pattern.
This option is ignored if awslogs-datetime-format is also configured.
You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options.
Required: No
Valid values: non-blocking | blocking
This option defines the delivery mode of log messages from the container to CloudWatch Logs. The delivery mode you choose affects application availability when the flow of logs from container to CloudWatch is interrupted.
If you use the blocking mode and the flow of logs to CloudWatch is interrupted, calls from container code to write to the stdout and stderr streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are instead stored in an in-memory intermediate buffer configured with the max-buffer-size option. This prevents the application from becoming unresponsive when logs cannot be sent to CloudWatch. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver.
max-buffer-size
Required: No
Default value: 1m
When non-blocking mode is used, the max-buffer-size log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a splunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network destination for log storage and analytics, you can set the log-driver-buffer-limit option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with region and a name for the log stream with delivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with region and a data stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name, Host (OpenSearch Service endpoint without protocol), Port, Index, Type, Aws_auth, Aws_region, Suppress_Type_Name, and tls.
When you export logs to Amazon S3, you can specify the bucket using the bucket option. You can also specify region, total_file_size, upload_timeout, and use_put_object as options.
This parameter requires version 1.19 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}}'
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
name (string) --
The name of the secret.
valueFrom (string) --
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.
volumeConfigurations (list) --
The volumes that are configured at deployment that the service revision uses.
(dict) --
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
name (string) --
The name of the volume. This value must match the volume name from the Volume object in the task definition.
managedEBSVolume (dict) --
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.
encrypted (boolean) --
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
kmsKeyId (string) --
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.
volumeType (string) --
The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.
The following are the supported volume types.
General Purpose SSD: gp2``| ``gp3
Provisioned IOPS SSD: io1``| ``io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
sizeInGiB (integer) --
The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
snapshotId (string) --
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
iops (integer) --
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
throughput (integer) --
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
tagSpecifications (list) --
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
(dict) --
The tag specifications of an Amazon EBS volume.
resourceType (string) --
The type of volume resource.
tags (list) --
The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can't be used.
(dict) --
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
propagateTags (string) --
Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a SERVICE specified in
ServiceVolumeConfiguration. If no value is specified, the tags aren't propagated.
roleArn (string) --
The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.
filesystemType (string) --
The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
The available Linux filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
The available Windows filesystem types are NTFS.
fargateEphemeralStorage (dict) --
The amount of ephemeral storage to allocate for the deployment.
kmsKeyId (string) --
Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for deployment.
createdAt (datetime) --
The time that the service revision was created. The format is yyyy-mm-dd HH:mm:ss.SSSSS.
failures (list) --
Any failures associated with the call.
(dict) --
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
detail (string) --
The details of the failure.
Describes one or more of your service deployments.
A service deployment happens when you release a software update for the service. For more information, see Amazon ECS service deployments.
See also: AWS API Documentation
Request Syntax
client.describe_service_deployments(
serviceDeploymentArns=[
'string',
]
)
list
[REQUIRED]
The ARN of the service deployment.
You can specify a maximum of 20 ARNs.
(string) --
dict
Response Syntax
{
'serviceDeployments': [
{
'serviceDeploymentArn': 'string',
'serviceArn': 'string',
'clusterArn': 'string',
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'finishedAt': datetime(2015, 1, 1),
'stoppedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'sourceServiceRevisions': [
{
'arn': 'string',
'requestedTaskCount': 123,
'runningTaskCount': 123,
'pendingTaskCount': 123
},
],
'targetServiceRevision': {
'arn': 'string',
'requestedTaskCount': 123,
'runningTaskCount': 123,
'pendingTaskCount': 123
},
'status': 'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
'statusReason': 'string',
'deploymentConfiguration': {
'deploymentCircuitBreaker': {
'enable': True|False,
'rollback': True|False
},
'maximumPercent': 123,
'minimumHealthyPercent': 123,
'alarms': {
'alarmNames': [
'string',
],
'rollback': True|False,
'enable': True|False
}
},
'rollback': {
'reason': 'string',
'startedAt': datetime(2015, 1, 1),
'serviceRevisionArn': 'string'
},
'deploymentCircuitBreaker': {
'status': 'TRIGGERED'|'MONITORING'|'MONITORING_COMPLETE'|'DISABLED',
'failureCount': 123,
'threshold': 123
},
'alarms': {
'status': 'TRIGGERED'|'MONITORING'|'MONITORING_COMPLETE'|'DISABLED',
'alarmNames': [
'string',
],
'triggeredAlarmNames': [
'string',
]
}
},
],
'failures': [
{
'arn': 'string',
'reason': 'string',
'detail': 'string'
},
]
}
Response Structure
(dict) --
serviceDeployments (list) --
The list of service deployments described.
(dict) --
Information about the service deployment.
Service deployments provide a comprehensive view of your deployments. For information about service deployments, see View service history using Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide .
serviceDeploymentArn (string) --
The ARN of the service deployment.
serviceArn (string) --
The ARN of the service for this service deployment.
clusterArn (string) --
The ARN of the cluster that hosts the service.
createdAt (datetime) --
The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
startedAt (datetime) --
The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
finishedAt (datetime) --
The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
stoppedAt (datetime) --
The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
The service deployment stops when any of the following actions happen:
A user manually stops the deployment
The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.
updatedAt (datetime) --
The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
sourceServiceRevisions (list) --
The currently deployed workload configuration.
(dict) --
The information about the number of requested, pending, and running tasks for a service revision.
arn (string) --
The ARN of the service revision.
requestedTaskCount (integer) --
The number of requested tasks for the service revision.
runningTaskCount (integer) --
The number of running tasks for the service revision.
pendingTaskCount (integer) --
The number of pending tasks for the service revision.
targetServiceRevision (dict) --
The workload configuration being deployed.
arn (string) --
The ARN of the service revision.
requestedTaskCount (integer) --
The number of requested tasks for the service revision.
runningTaskCount (integer) --
The number of running tasks for the service revision.
pendingTaskCount (integer) --
The number of pending tasks for the service revision.
status (string) --
The service deployment state.
statusReason (string) --
Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
deploymentConfiguration (dict) --
Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.
deploymentCircuitBreaker (dict) --
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide
enable (boolean) --
Determines whether to use the deployment circuit breaker logic for the service.
rollback (boolean) --
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
maximumPercent (integer) --
If a service is using the rolling update ( ECS) deployment type, the maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA service scheduler and has a desiredCount of four tasks and a maximumPercent 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 maximumPercent value for a service using the REPLICA service scheduler is 200%.
If a service is using either the blue/green ( CODE_DEPLOY) or EXTERNAL deployment types, and tasks in the service use the EC2 launch type, the maximum percent value is set to the default value. The maximum percent value 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.
minimumHealthyPercent (integer) --
If a service is using the rolling update ( ECS) deployment type, the minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for minimumHealthyPercent is 100%. The default minimumHealthyPercent value for a service using the DAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the desiredCount multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer value.
If a service is using either the blue/green ( CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value. The minimum healthy percent value 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 a service is using either the blue/green ( CODE_DEPLOY) or EXTERNAL deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
alarms (dict) --
Information about the CloudWatch alarms.
alarmNames (list) --
One or more CloudWatch alarm names. Use a "," to separate the alarms.
(string) --
rollback (boolean) --
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
enable (boolean) --
Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback (dict) --
The rollback options the service deployment uses when the deployment fails.
reason (string) --
The reason the rollback happened. For example, the circuit breaker initiated the rollback operation.
startedAt (datetime) --
Time time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
serviceRevisionArn (string) --
The ARN of the service revision deployed as part of the rollback.
When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
deploymentCircuitBreaker (dict) --
The circuit breaker configuration that determines a service deployment failed.
status (string) --
The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.
failureCount (integer) --
The number of times the circuit breaker detected a service deploymeny failure.
threshold (integer) --
The threshhold which determines that the service deployment failed.
The deployment circuit breaker calculates the threshold value, and then uses the value to determine when to move the deployment to a FAILED state. The deployment circuit breaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values in the following formula to determine the deployment failure.
0.5 * desired task count
alarms (dict) --
The CloudWatch alarms that determine when a service deployment fails.
status (string) --
The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
alarmNames (list) --
The name of the CloudWatch alarms that determine when a service deployment failed. A "," separates the alarms.
(string) --
triggeredAlarmNames (list) --
One or more CloudWatch alarm names that have been triggered during the service deployment. A "," separates the alarm names.
(string) --
failures (list) --
Any failures associated with the call.
If you decsribe a deployment with a service revision created before October 25, 2024, the call fails. The failure includes the service revision ARN and the reason set to MISSING.
(dict) --
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
arn (string) --
The Amazon Resource Name (ARN) of the failed resource.
reason (string) --
The reason for the failure.
detail (string) --
The details of the failure.