ECS / Client / describe_capacity_providers

describe_capacity_providers#

ECS.Client.describe_capacity_providers(**kwargs)#

Describes one or more of your capacity providers.

Request Syntax

response = client.describe_capacity_providers(
    capacityProviders=[
        'string',
    ],
    include=[
        'TAGS',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

capacityProviders (list) –
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.
- (string) –
include (list) –
Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren’t included in the response.
- (string) –
maxResults (integer) – The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
nextToken (string) –
The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Return type:

dict

Returns:

Response Syntax

{
    'capacityProviders': [
        {
            'capacityProviderArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'autoScalingGroupProvider': {
                'autoScalingGroupArn': 'string',
                'managedScaling': {
                    'status': 'ENABLED'|'DISABLED',
                    'targetCapacity': 123,
                    'minimumScalingStepSize': 123,
                    'maximumScalingStepSize': 123,
                    'instanceWarmupPeriod': 123
                },
                'managedTerminationProtection': 'ENABLED'|'DISABLED',
                'managedDraining': 'ENABLED'|'DISABLED'
            },
            'updateStatus': 'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
            'updateStatusReason': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string',
            'detail': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- capacityProviders (list) –
  
  The list of capacity providers.
  - (dict) –
    
    The details for a capacity provider.
    - capacityProviderArn (string) –
      
      The Amazon Resource Name (ARN) that identifies the capacity provider.
    - name (string) –
      
      The name of the capacity provider.
    - status (string) –
      
      The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.
    - autoScalingGroupProvider (dict) –
      
      The Auto Scaling group settings for the capacity provider.
      - autoScalingGroupArn (string) –
        
        The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
      - managedScaling (dict) –
        
        The managed scaling settings for the Auto Scaling group capacity provider.
        
        status (string) –
        
        Determines whether to use managed scaling for the capacity provider.
        
        targetCapacity (integer) –
        
        The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a targetCapacity of 90. The default value of 100 percent results in the Amazon EC2 instances in your Auto Scaling group being completely used.
        
        minimumScalingStepSize (integer) –
        
        The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.
        
        When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.
        
        If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.
        
        maximumScalingStepSize (integer) –
        
        The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter. If this parameter is omitted, the default value of 10000 is used.
        
        instanceWarmupPeriod (integer) –
        
        The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is used.
      - managedTerminationProtection (string) –
        
        The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.
        
        Warning
        When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn’t work.
        
        When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
        
        When managed termination protection is off, your Amazon EC2 instances aren’t protected from termination when the Auto Scaling group scales in.
      - managedDraining (string) –
        
        The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.
    - updateStatus (string) –
      
      The update status of the capacity provider. The following are the possible states that is returned.
      
      DELETE_IN_PROGRESS
      
      The capacity provider is in the process of being deleted.
      
      DELETE_COMPLETE
      
      The capacity provider was successfully deleted and has an INACTIVE status.
      
      DELETE_FAILED
      
      The capacity provider can’t be deleted. The update status reason provides further details about why the delete failed.
    - updateStatusReason (string) –
      
      The update status reason. This provides further details about the update status for the capacity provider.
    - tags (list) –
      
      The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
      
      The following basic restrictions apply to tags:
      - Maximum number of tags per resource - 50
      - For each resource, each tag key must be unique, and each tag key can have only one value.
      - Maximum key length - 128 Unicode characters in UTF-8
      - Maximum value length - 256 Unicode characters in UTF-8
      - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
      - Tag keys and values are case-sensitive.
      - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
      - (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).
- failures (list) –
  
  Any failures associated with the call.
  - (dict) –
    
    A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the failed resource.
    - reason (string) –
      
      The reason for the failure.
    - detail (string) –
      
      The details of the failure.
- nextToken (string) –
  
  The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

ECS.Client.exceptions.ServerException
ECS.Client.exceptions.ClientException
ECS.Client.exceptions.InvalidParameterException