Lambda / Client / get_capacity_provider

get_capacity_provider

Lambda.Client.get_capacity_provider(**kwargs)

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_provider(
    CapacityProviderName='string'
)
Parameters:

CapacityProviderName (string) –

[REQUIRED]

The name of the capacity provider to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityProvider': {
        'CapacityProviderArn': 'string',
        'State': 'Pending'|'Active'|'Failed'|'Deleting',
        'VpcConfig': {
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'PermissionsConfig': {
            'CapacityProviderOperatorRoleArn': 'string'
        },
        'InstanceRequirements': {
            'Architectures': [
                'x86_64'|'arm64',
            ],
            'AllowedInstanceTypes': [
                'string',
            ],
            'ExcludedInstanceTypes': [
                'string',
            ]
        },
        'CapacityProviderScalingConfig': {
            'MaxVCpuCount': 123,
            'ScalingMode': 'Auto'|'Manual',
            'ScalingPolicies': [
                {
                    'PredefinedMetricType': 'LambdaCapacityProviderAverageCPUUtilization',
                    'TargetValue': 123.0
                },
            ]
        },
        'KmsKeyArn': 'string',
        'LastModified': 'string'
    }
}

Response Structure

  • (dict) –

    • CapacityProvider (dict) –

      Information about the capacity provider, including its configuration and current state.

      • CapacityProviderArn (string) –

        The Amazon Resource Name (ARN) of the capacity provider.

      • State (string) –

        The current state of the capacity provider.

      • VpcConfig (dict) –

        The VPC configuration for the capacity provider.

        • SubnetIds (list) –

          A list of subnet IDs where the capacity provider launches compute instances.

          • (string) –

        • SecurityGroupIds (list) –

          A list of security group IDs that control network access for compute instances managed by the capacity provider.

          • (string) –

      • PermissionsConfig (dict) –

        The permissions configuration for the capacity provider.

        • CapacityProviderOperatorRoleArn (string) –

          The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.

      • InstanceRequirements (dict) –

        The instance requirements for compute resources managed by the capacity provider.

        • Architectures (list) –

          A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64.

          • (string) –

        • AllowedInstanceTypes (list) –

          A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.

          • (string) –

        • ExcludedInstanceTypes (list) –

          A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.

          • (string) –

      • CapacityProviderScalingConfig (dict) –

        The scaling configuration for the capacity provider.

        • MaxVCpuCount (integer) –

          The maximum number of vCPUs that the capacity provider can provision across all compute instances.

        • ScalingMode (string) –

          The scaling mode that determines how the capacity provider responds to changes in demand.

        • ScalingPolicies (list) –

          A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.

          • (dict) –

            A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.

            • PredefinedMetricType (string) –

              The predefined metric type to track for scaling decisions.

            • TargetValue (float) –

              The target value for the metric that the scaling policy attempts to maintain through scaling actions.

      • KmsKeyArn (string) –

        The ARN of the KMS key used to encrypt the capacity provider’s resources.

      • LastModified (string) –

        The date and time when the capacity provider was last modified.

Exceptions