:doc:`ECS <../../ecs>` / Client / describe_service_revisions

**************************
describe_service_revisions
**************************



.. py:method:: ECS.Client.describe_service_revisions(**kwargs)

  

  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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html>`__.

   

  You can't describe a service revision that was created before October 25, 2024.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServiceRevisions>`_  


  **Request Syntax**
  ::

    response = client.describe_service_revisions(
        serviceRevisionArns=[
            'string',
        ]
    )
    
  :type serviceRevisionArns: list
  :param serviceRevisionArns: **[REQUIRED]** 

    The ARN of the service revision.

     

    You can specify a maximum of 20 ARNs.

     

    You can call `ListServiceDeployments <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServiceDeployments.html>`__ to get the ARNs.

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'serviceRevisions': [
              {
                  'serviceRevisionArn': 'string',
                  'serviceArn': 'string',
                  'clusterArn': 'string',
                  'taskDefinition': 'string',
                  'capacityProviderStrategy': [
                      {
                          'capacityProvider': 'string',
                          'weight': 123,
                          'base': 123
                      },
                  ],
                  'launchType': 'EC2'|'FARGATE'|'EXTERNAL'|'MANAGED_INSTANCES',
                  'platformVersion': 'string',
                  'platformFamily': 'string',
                  'loadBalancers': [
                      {
                          'targetGroupArn': 'string',
                          'loadBalancerName': 'string',
                          'containerName': 'string',
                          'containerPort': 123,
                          'advancedConfiguration': {
                              'alternateTargetGroupArn': 'string',
                              'productionListenerRule': 'string',
                              'testListenerRule': 'string',
                              'roleArn': 'string'
                          }
                      },
                  ],
                  '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',
                                      'testTrafficRules': {
                                          'header': {
                                              'name': 'string',
                                              'value': {
                                                  'exact': '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'
                              },
                          ]
                      },
                      'accessLogConfiguration': {
                          'format': 'TEXT'|'JSON',
                          'includeQueryParameters': 'DISABLED'|'ENABLED'
                      }
                  },
                  'volumeConfigurations': [
                      {
                          'name': 'string',
                          'managedEBSVolume': {
                              'encrypted': True|False,
                              'kmsKeyId': 'string',
                              'volumeType': 'string',
                              'sizeInGiB': 123,
                              'snapshotId': 'string',
                              'volumeInitializationRate': 123,
                              '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),
                  'vpcLatticeConfigurations': [
                      {
                          'roleArn': 'string',
                          'targetGroupArn': 'string',
                          'portName': 'string'
                      },
                  ],
                  'resolvedConfiguration': {
                      'loadBalancers': [
                          {
                              'targetGroupArn': 'string',
                              'productionListenerRule': 'string'
                          },
                      ]
                  },
                  'ecsManagedResources': {
                      'ingressPaths': [
                          {
                              'accessType': 'PUBLIC'|'PRIVATE',
                              'endpoint': 'string',
                              'loadBalancer': {
                                  'arn': 'string',
                                  'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                  'statusReason': 'string',
                                  'updatedAt': datetime(2015, 1, 1),
                                  'scheme': 'string',
                                  'subnetIds': [
                                      'string',
                                  ],
                                  'securityGroupIds': [
                                      'string',
                                  ]
                              },
                              'loadBalancerSecurityGroups': [
                                  {
                                      'arn': 'string',
                                      'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                      'statusReason': 'string',
                                      'updatedAt': datetime(2015, 1, 1)
                                  },
                              ],
                              'certificate': {
                                  'arn': 'string',
                                  'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                  'statusReason': 'string',
                                  'updatedAt': datetime(2015, 1, 1),
                                  'domainName': 'string'
                              },
                              'listener': {
                                  'arn': 'string',
                                  'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                  'statusReason': 'string',
                                  'updatedAt': datetime(2015, 1, 1)
                              },
                              'rule': {
                                  'arn': 'string',
                                  'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                  'statusReason': 'string',
                                  'updatedAt': datetime(2015, 1, 1)
                              },
                              'targetGroups': [
                                  {
                                      'arn': 'string',
                                      'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                      'statusReason': 'string',
                                      'updatedAt': datetime(2015, 1, 1),
                                      'healthCheckPath': 'string',
                                      'healthCheckPort': 123,
                                      'port': 123
                                  },
                              ]
                          },
                      ],
                      'autoScaling': {
                          'scalableTarget': {
                              'arn': 'string',
                              'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                              'statusReason': 'string',
                              'updatedAt': datetime(2015, 1, 1),
                              'minCapacity': 123,
                              'maxCapacity': 123
                          },
                          'applicationAutoScalingPolicies': [
                              {
                                  'arn': 'string',
                                  'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                                  'statusReason': 'string',
                                  'updatedAt': datetime(2015, 1, 1),
                                  'policyType': 'string',
                                  'targetValue': 123.0,
                                  'metric': 'string'
                              },
                          ]
                      },
                      'metricAlarms': [
                          {
                              'arn': 'string',
                              'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                              'statusReason': 'string',
                              'updatedAt': datetime(2015, 1, 1)
                          },
                      ],
                      'serviceSecurityGroups': [
                          {
                              'arn': 'string',
                              'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                              'statusReason': 'string',
                              'updatedAt': datetime(2015, 1, 1)
                          },
                      ],
                      'logGroups': [
                          {
                              'arn': 'string',
                              'status': 'PROVISIONING'|'ACTIVE'|'DEPROVISIONING'|'DELETED'|'FAILED',
                              'statusReason': 'string',
                              'updatedAt': datetime(2015, 1, 1),
                              'logGroupName': 'string'
                          },
                      ]
                  }
              },
          ],
          '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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html>`__ 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 can contain a maximum of 20 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.

                 

                Weight value characteristics:

                 

                
                * Weight is considered after the base value is satisfied
                 
                * The default value is ``0`` if not specified
                 
                * The valid range is 0 to 1,000
                 
                * At least one capacity provider must have a weight greater than zero
                 
                * Capacity providers with weight of ``0`` cannot place tasks
                

                 

                Task distribution logic:

                 

                 
                * Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider
                 
                * Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios
                 

                 

                Examples:

                 

                Equal Distribution: Two capacity providers both with weight ``1`` will split tasks evenly after base requirements are met.

                 

                Weighted Distribution: If capacityProviderA has weight ``1`` and capacityProviderB has weight ``4``, then for every 1 task on A, 4 tasks will run on B.

                
              

              - **base** *(integer) --* 

                The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. 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.

                 

                Base value characteristics:

                 

                
                * Only one capacity provider in a strategy can have a base defined
                 
                * The default value is ``0`` if not specified
                 
                * The valid range is 0 to 100,000
                 
                * Base requirements are satisfied first before weight distribution
                

                
          
        
          

          - **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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html>`__ in the *Amazon Elastic Container Service Developer Guide*.

                 

                For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see `Blue/green deployment with CodeDeploy <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html>`__ in the *Amazon Elastic Container Service Developer Guide*.

                 

                .. warning::

                   

                  If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.

                  

                
              

              - **loadBalancerName** *(string) --* 

                The name of the load balancer to associate with the Amazon ECS 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.

                
              

              - **advancedConfiguration** *(dict) --* 

                The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments.

                
                

                - **alternateTargetGroupArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.

                  
                

                - **productionListenerRule** *(string) --* 

                  The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic.

                  
                

                - **testListenerRule** *(string) --* 

                  The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic.

                  
                

                - **roleArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you.

                  
            
          
        
          

          - **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 <https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html>`__.

                
              

              - **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.

               

              .. note::

                

                All specified subnets and security groups must be from the same VPC.

                

              
              

              - **subnets** *(list) --* 

                The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.

                 

                .. note::

                  

                  All specified subnets must be from the same VPC.

                  

                
                

                - *(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.

                 

                .. note::

                  

                  All specified security groups must be from the same VPC.

                  

                
                

                - *(string) --* 
            
              

              - **assignPublicIp** *(string) --* 

                Whether the task's elastic network interface receives a public IP address.

                 

                Consider the following when you set this value:

                 

                
                * When you use ``create-service`` or ``update-service``, the default is ``DISABLED``.
                 
                * When the service ``deploymentController`` is ``ECS``, the value must be ``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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ 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 <https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ in the *Amazon Elastic Container Service Developer Guide*.

                      
                    

                    - **testTrafficRules** *(dict) --* 

                      The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.

                      
                      

                      - **header** *(dict) --* 

                        The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers.

                        
                        

                        - **name** *(string) --* 

                          The name of the HTTP header to examine for test traffic routing. Common examples include custom headers like ``X-Test-Version`` or ``X-Canary-Request`` that can be used to identify test traffic.

                          
                        

                        - **value** *(dict) --* 

                          The header value matching configuration that determines how the HTTP header value is evaluated for test traffic routing decisions.

                          
                          

                          - **exact** *(string) --* 

                            The exact value that the HTTP header must match for the test traffic routing rule to apply. This provides precise control over which requests are routed to the new service revision during blue/green deployments.

                            
                      
                    
                  
                
              
                

                - **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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html>`__.

                 

                .. note::

                  

                  If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's `available on GitHub <https://github.com/aws/amazon-ecs-agent>`__ and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

                  

                
              

              - **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``.

                 

                .. note::

                  

                  Your IAM policy must include the ``logs:CreateLogGroup`` permission before you attempt to use ``awslogs-create-group``.

                  

                  awslogs-region  

                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 Fargate.Optional when using EC2.

                 

                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 <https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format>`__.

                 

                You cannot configure both the ``awslogs-datetime-format`` and ``awslogs-multiline-pattern`` options.

                 

                .. note::

                  

                  Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.

                  

                  awslogs-multiline-pattern  

                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 <https://docs.docker.com/config/containers/logging/awslogs/#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.

                 

                .. note::

                  

                  Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.

                  

                   

                The following options apply to all supported log drivers.

                  mode  

                Required: No

                 

                Valid values: ``non-blocking`` | ``blocking``

                 

                This option defines the delivery mode of log messages from the container to the log driver specified using ``logDriver``. The delivery mode you choose affects application availability when the flow of logs from container is interrupted.

                 

                If you use the ``blocking`` mode and the flow of logs 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. 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 <http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/>`__.

                 

                You can set a default ``mode`` for all containers in a specific Amazon Web Services Region by using the ``defaultLogDriverMode`` account setting. If you don't specify the ``mode`` option or configure the account setting, Amazon ECS will default to the ``non-blocking`` mode. For more information about the account setting, see `Default log driver mode <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#default-log-driver-mode>`__ in the *Amazon Elastic Container Service Developer Guide*.

                 

                .. note::

                  

                  On June 25, 2025, Amazon ECS changed the default log driver mode from ``blocking`` to ``non-blocking`` to prioritize task availability over logging. To continue using the ``blocking`` mode after this change, do one of the following:

                   

                  
                  * Set the ``mode`` option in your container definition's ``logConfiguration`` as ``blocking``.
                   
                  * Set the ``defaultLogDriverMode`` account setting to ``blocking``.
                  

                  

                  max-buffer-size  

                Required: No

                 

                Default value: ``10m``

                 

                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``. For more information, see `Under the hood\: FireLens for Amazon ECS Tasks <http://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/>`__.

                 

                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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html>`__ 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 <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*.

                     

                    .. note::

                      

                      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.

                      

                    
              
            
          
            

            - **accessLogConfiguration** *(dict) --* 

              The configuration for Service Connect access logging. Access logs capture detailed information about requests made to your service, including request patterns, response codes, and timing data. They can be useful for debugging connectivity issues, monitoring service performance, and auditing service-to-service communication for security and compliance purposes.

               

              .. note::

                

                To enable access logs, you must also specify a ``logConfiguration`` in the ``serviceConnectConfiguration``.

                

              
              

              - **format** *(string) --* 

                The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.

                
              

              - **includeQueryParameters** *(string) --* 

                Specifies whether to include query parameters in Service Connect access logs.

                 

                When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is ``DISABLED``.

                
          
        
          

          - **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 you turn on Region-level Amazon EBS encryption by default but set this value as ``false``, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ 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 a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ in the *Amazon EC2 API Reference*. For more information about encrypting Amazon EBS volumes attached to tasks, see `Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html>`__.

                   

                  .. warning::

                     

                    Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.

                    

                  
                

                - **volumeType** *(string) --* 

                  The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ in the *Amazon EC2 API Reference*. For more information, see `Amazon EBS volume types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html>`__ 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`` 

                  .. note::

                    The magnetic volume type is not supported on Fargate.

                  
                  

                  
                

                - **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 <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ 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 volumes for attachment to tasks maintained by the service. You must specify either ``snapshotId`` or ``sizeInGiB`` in your volume configuration. This parameter maps 1:1 with the ``SnapshotId`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ in the *Amazon EC2 API Reference*.

                  
                

                - **volumeInitializationRate** *(integer) --* 

                  The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a ``snapshotId``. For more information, see `Initialize Amazon EBS volumes <https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html>`__ in the *Amazon EBS User Guide*.

                  
                

                - **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 <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ 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 <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ in the *Amazon EC2 API Reference*.

                   

                  .. warning::

                     

                    This parameter is only supported for the ``gp3`` volume type.

                    

                  
                

                - **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 <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`__ 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 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html>`__ 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 tasks 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 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.

            
          

          - **vpcLatticeConfigurations** *(list) --* 

            The VPC Lattice configuration for the service revision.

            
            

            - *(dict) --* 

              The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.

              
              

              - **roleArn** *(string) --* 

                The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS infrastructure IAM role that is used to manage your VPC Lattice infrastructure.

                
              

              - **targetGroupArn** *(string) --* 

                The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to.

                
              

              - **portName** *(string) --* 

                The name of the port mapping to register in the VPC Lattice target group. This is the name of the ``portMapping`` you defined in your task definition.

                
          
        
          

          - **resolvedConfiguration** *(dict) --* 

            The resolved configuration for the service revision which contains the actual resources your service revision uses, such as which target groups serve traffic.

            
            

            - **loadBalancers** *(list) --* 

              The resolved load balancer configuration for the service revision. This includes information about which target groups serve traffic and which listener rules direct traffic to them.

              
              

              - *(dict) --* 

                The resolved load balancer configuration for a service revision. This includes information about which target groups serve traffic and which listener rules direct traffic to them.

                
                

                - **targetGroupArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the target group associated with the service revision.

                  
                

                - **productionListenerRule** *(string) --* 

                  The Amazon Resource Name (ARN) of the production listener rule or listener that directs traffic to the target group associated with the service revision.

                  
            
          
        
          

          - **ecsManagedResources** *(dict) --* 

            The resources created and managed by Amazon ECS when you create an Express service for Amazon ECS.

            
            

            - **ingressPaths** *(list) --* 

              The ingress paths and endpoints for the Express service.

              
              

              - *(dict) --* 

                The entry point into the Express service.

                
                

                - **accessType** *(string) --* 

                  The type of access to the endpoint for the Express service.

                  
                

                - **endpoint** *(string) --* 

                  The endpoint for access to the Express service.

                  
                

                - **loadBalancer** *(dict) --* 

                  The Application Load Balancer associated with the Express service.

                  
                  

                  - **arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the load balancer.

                    
                  

                  - **status** *(string) --* 

                    The status of the load balancer.

                    
                  

                  - **statusReason** *(string) --* 

                    Information about why the load balancer is in the current status.

                    
                  

                  - **updatedAt** *(datetime) --* 

                    The Unix timestamp for when this load balancer was most recently updated.

                    
                  

                  - **scheme** *(string) --* 

                    The scheme of the load balancer. By default, the scheme of the load balancer is ``internet-facing``.

                    
                  

                  - **subnetIds** *(list) --* 

                    The IDs of the subnets associated with the load balancer.

                    
                    

                    - *(string) --* 
                
                  

                  - **securityGroupIds** *(list) --* 

                    The IDs of the security groups associated with the load balancer.

                    
                    

                    - *(string) --* 
                
              
                

                - **loadBalancerSecurityGroups** *(list) --* 

                  The security groups associated with the Application Load Balancer.

                  
                  

                  - *(dict) --* 

                    A security group associated with the Express service.

                    
                    

                    - **arn** *(string) --* 

                      The ARN of the security group.

                      
                    

                    - **status** *(string) --* 

                      The status of the security group.

                      
                    

                    - **statusReason** *(string) --* 

                      Information about why the security group is in the current status.

                      
                    

                    - **updatedAt** *(datetime) --* 

                      The Unix timestamp for when the security group was last updated.

                      
                
              
                

                - **certificate** *(dict) --* 

                  The ACM certificate for the Express service's domain.

                  
                  

                  - **arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the ACM certificate.

                    
                  

                  - **status** *(string) --* 

                    The status of the ACM; certificate.

                    
                  

                  - **statusReason** *(string) --* 

                    Information about why the ACM certificate is in the current status.

                    
                  

                  - **updatedAt** *(datetime) --* 

                    The Unix timestamp for when the ACM certificate was last updated

                    
                  

                  - **domainName** *(string) --* 

                    The fully qualified domain name (FQDN) that is secured with this ACM certificate.

                    
              
                

                - **listener** *(dict) --* 

                  The listeners associated with the Application Load Balancer.

                  
                  

                  - **arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the load balancer listener.

                    
                  

                  - **status** *(string) --* 

                    The status of the load balancer listener.

                    
                  

                  - **statusReason** *(string) --* 

                    Informaion about why the load balancer listener is in the current status.

                    
                  

                  - **updatedAt** *(datetime) --* 

                    The Unix timestamp for when this listener was most recently updated.

                    
              
                

                - **rule** *(dict) --* 

                  The listener rules for the Application Load Balancer.

                  
                  

                  - **arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the load balancer listener rule.

                    
                  

                  - **status** *(string) --* 

                    The status of the load balancer listener rule.

                    
                  

                  - **statusReason** *(string) --* 

                    Information about why the load balancer listener rule is in the current status.

                    
                  

                  - **updatedAt** *(datetime) --* 

                    The Unix timestamp for when this listener rule was most recently updated.

                    
              
                

                - **targetGroups** *(list) --* 

                  The target groups associated with the Application Load Balancer.

                  
                  

                  - *(dict) --* 

                    The target group associated with the Express service's Application Load Balancer. For more information about load balancer target groups, see `CreateTargetGroup <https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateTargetGroup.html>`__ in the *Elastic Load Balancing API Reference*

                    
                    

                    - **arn** *(string) --* 

                      The Amazon Resource Name (ARN) of the target group.

                      
                    

                    - **status** *(string) --* 

                      The status of the target group.

                      
                    

                    - **statusReason** *(string) --* 

                      Information about why the target group is in the current status.

                      
                    

                    - **updatedAt** *(datetime) --* 

                      The Unix timestamp for when the target group was last updated.

                      
                    

                    - **healthCheckPath** *(string) --* 

                      The destination for health checks on the targets.

                      
                    

                    - **healthCheckPort** *(integer) --* 

                      The port the load balancer uses when performing health checks on targets.

                      
                    

                    - **port** *(integer) --* 

                      The port on which the targets receive traffic.

                      
                
              
            
          
            

            - **autoScaling** *(dict) --* 

              The auto-scaling configuration and policies for the Express service.

              
              

              - **scalableTarget** *(dict) --* 

                Represents a scalable target.

                
                

                - **arn** *(string) --* 

                  The ARN of the scalable target.

                  
                

                - **status** *(string) --* 

                  The status of the scalable target.

                  
                

                - **statusReason** *(string) --* 

                  Information about why the scalable target is in the current status.

                  
                

                - **updatedAt** *(datetime) --* 

                  The Unix timestamp for when the target was most recently updated.

                  
                

                - **minCapacity** *(integer) --* 

                  The minimum value to scale to in response to a scale-in activity.

                  
                

                - **maxCapacity** *(integer) --* 

                  The maximum value to scale to in response to a scale-out activity.

                  
            
              

              - **applicationAutoScalingPolicies** *(list) --* 

                The policy used for auto scaling.

                
                

                - *(dict) --* 

                  The Application Auto Scaling policy created by Amazon ECS when you create an Express service.

                  
                  

                  - **arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the Application Auto Scaling policy associated with the Express service.

                    
                  

                  - **status** *(string) --* 

                    The status of Application Auto Scaling policy creation.

                    
                  

                  - **statusReason** *(string) --* 

                    Information about why the Application Auto Scaling policy is in the current status.

                    
                  

                  - **updatedAt** *(datetime) --* 

                    The Unix timestamp for when the Application Auto Scaling policy was last updated.

                    
                  

                  - **policyType** *(string) --* 

                    The type of Application Auto Scaling policy associated with the Express service. Valid values are ``TargetTrackingScaling``, ``StepScaling``, and ``PredictiveScaling``.

                    
                  

                  - **targetValue** *(float) --* 

                    The target value for the auto scaling metric.

                    
                  

                  - **metric** *(string) --* 

                    The metric used for auto scaling decisions. The available metrics are ``ECSServiceAverageCPUUtilization``, ``ECSServiceAverageMemoryUtilization``, and ``ALBRequestCOuntPerTarget``.

                    
              
            
          
            

            - **metricAlarms** *(list) --* 

              The CloudWatch metric alarms associated with the Express service.

              
              

              - *(dict) --* 

                The CloudWatch metric alarm associated with the Express service's scaling policy.

                
                

                - **arn** *(string) --* 

                  The Amazon Resource Name (ARN) of the CloudWatch metric alarm.

                  
                

                - **status** *(string) --* 

                  The status of the CloudWatch metric alarm.

                  
                

                - **statusReason** *(string) --* 

                  Information about why the CloudWatch metric alarm is in the current status.

                  
                

                - **updatedAt** *(datetime) --* 

                  The Unix timestamp for when the CloudWatch metric alarm was last updated.

                  
            
          
            

            - **serviceSecurityGroups** *(list) --* 

              The security groups managed by the Express service.

              
              

              - *(dict) --* 

                A security group associated with the Express service.

                
                

                - **arn** *(string) --* 

                  The ARN of the security group.

                  
                

                - **status** *(string) --* 

                  The status of the security group.

                  
                

                - **statusReason** *(string) --* 

                  Information about why the security group is in the current status.

                  
                

                - **updatedAt** *(datetime) --* 

                  The Unix timestamp for when the security group was last updated.

                  
            
          
            

            - **logGroups** *(list) --* 

              The log groups managed by the Express service.

              
              

              - *(dict) --* 

                The Cloudwatch Log Group created by Amazon ECS for an Express service.

                
                

                - **arn** *(string) --* 

                  The Amazon Resource Name (ARN) of the Cloudwatch Log Group associated with the Express service.

                  
                

                - **status** *(string) --* 

                  The status of the Cloudwatch LogGroup.

                  
                

                - **statusReason** *(string) --* 

                  Information about why the Cloudwatch LogGroup is in the current status.

                  
                

                - **updatedAt** *(datetime) --* 

                  The Unix timestamp for when the Cloudwatch LogGroup was last updated

                  
                

                - **logGroupName** *(string) --* 

                  The name of the Cloudwatch Log Group associated with the Express service.

                  
            
          
        
      
    
      

      - **failures** *(list) --* 

        Any failures associated with the call.

        
        

        - *(dict) --* 

          A failed resource. For a list of common causes, see `API failure reasons <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html>`__ 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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ECS.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ECS.Client.exceptions.ClientException`

  
  *   :py:class:`ECS.Client.exceptions.ClusterNotFoundException`

  
  *   :py:class:`ECS.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`ECS.Client.exceptions.ServerException`

  
  *   :py:class:`ECS.Client.exceptions.ServiceNotFoundException`

  
  *   :py:class:`ECS.Client.exceptions.UnsupportedFeatureException`

  