Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCapacityProvider

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

Request Syntax


GET /2025-11-30/capacity-providers/CapacityProviderName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CapacityProviderName

The name of the capacity provider to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: (arn:aws[a-zA-Z-]*:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:capacity-provider:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CapacityProvider": { 
      "CapacityProviderArn": "string",
      "CapacityProviderScalingConfig": { 
         "MaxVCpuCount": number,
         "ScalingMode": "string",
         "ScalingPolicies": [ 
            { 
               "PredefinedMetricType": "string",
               "TargetValue": number
            }
         ]
      },
      "InstanceRequirements": { 
         "AllowedInstanceTypes": [ "string" ],
         "Architectures": [ "string" ],
         "ExcludedInstanceTypes": [ "string" ]
      },
      "KmsKeyArn": "string",
      "LastModified": "string",
      "PermissionsConfig": { 
         "CapacityProviderOperatorRoleArn": "string"
      },
      "State": "string",
      "VpcConfig": { 
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ]
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CapacityProvider

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

Type: CapacityProvider object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

One of the parameters in the request is not valid.

message: The exception message.
Type: The exception type.

HTTP Status Code: 400

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ServiceException

The AWS Lambda service encountered an internal error.

HTTP Status Code: 500

TooManyRequestsException

The request throughput limit was exceeded. For more information, see Lambda quotas.

retryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 429