AWS Lambda Lambda Capacity Providers API

openapi: 3.2.0
info:
  title: AWS Lambda Capacity Providers API
  version: '2015-03-31'
  description: Generated from AWS's published Smithy model for AWS Lambda. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lambda.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Capacity Providers
paths:
  /2025-11-30/capacity-providers:
    post:
      operationId: CreateCapacityProvider
      summary: Create Capacity Provider
      description: Creates a capacity provider that manages compute resources for Lambda Event Functions
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCapacityProviderResponse'
        '400':
          description: CapacityProviderLimitExceededException; InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityProviderLimitExceededException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCapacityProviderRequest'
      tags:
      - Capacity Providers
    get:
      operationId: ListCapacityProviders
      summary: List Capacity Providers
      description: Returns a list of capacity providers in your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCapacityProvidersResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCapacityProvidersRequest'
      tags:
      - Capacity Providers
  /2025-11-30/capacity-providers/{CapacityProviderName}:
    get:
      operationId: GetCapacityProvider
      summary: Get Capacity Provider
      description: Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCapacityProviderResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCapacityProviderRequest'
      tags:
      - Capacity Providers
    put:
      operationId: UpdateCapacityProvider
      summary: Update Capacity Provider
      description: Updates the configuration of an existing capacity provider.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCapacityProviderResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCapacityProviderRequest'
      tags:
      - Capacity Providers
    delete:
      operationId: DeleteCapacityProvider
      summary: Delete Capacity Provider
      description: Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCapacityProviderResponse'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCapacityProviderRequest'
      tags:
      - Capacity Providers
components:
  schemas:
    InvalidParameterValueException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    CreateCapacityProviderResponse:
      type: object
      properties:
        CapacityProvider:
          $ref: '#/components/schemas/CapacityProvider'
      required:
      - CapacityProvider
    InstanceRequirements:
      type: object
      properties:
        Architectures:
          type: array
          items:
            type: string
            enum:
            - x86_64
            - arm64
          description: A list of supported CPU architectures for compute instances. Valid values include x86_64 and arm64.
        AllowedInstanceTypes:
          type: array
          items:
            type: string
          description: A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed.
        ExcludedInstanceTypes:
          type: array
          items:
            type: string
          description: A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements.
    GetCapacityProviderResponse:
      type: object
      properties:
        CapacityProvider:
          $ref: '#/components/schemas/CapacityProvider'
      required:
      - CapacityProvider
    CapacityProvider:
      type: object
      properties:
        CapacityProviderArn:
          type: string
          description: The Amazon Resource Name (ARN) of the capacity provider.
        State:
          type: string
          enum:
          - Pending
          - Active
          - Failed
          - Deleting
          description: The current state of the capacity provider.
        VpcConfig:
          $ref: '#/components/schemas/CapacityProviderVpcConfig'
        PermissionsConfig:
          $ref: '#/components/schemas/CapacityProviderPermissionsConfig'
        InstanceRequirements:
          $ref: '#/components/schemas/InstanceRequirements'
        CapacityProviderScalingConfig:
          $ref: '#/components/schemas/CapacityProviderScalingConfig'
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key used to encrypt the capacity provider's resources.
        LastModified:
          type: string
          description: The date and time when the capacity provider was last modified.
        PropagateTags:
          $ref: '#/components/schemas/PropagateTags'
        TelemetryConfig:
          $ref: '#/components/schemas/CapacityProviderTelemetryConfig'
      required:
      - CapacityProviderArn
      - State
      - VpcConfig
      - PermissionsConfig
    UpdateCapacityProviderResponse:
      type: object
      properties:
        CapacityProvider:
          $ref: '#/components/schemas/CapacityProvider'
      required:
      - CapacityProvider
    GetCapacityProviderRequest:
      type: object
      properties:
        CapacityProviderName:
          type: string
          description: The name of the capacity provider to retrieve.
      required:
      - CapacityProviderName
    ListCapacityProvidersResponse:
      type: object
      properties:
        CapacityProviders:
          type: array
          items:
            $ref: '#/components/schemas/CapacityProvider'
          description: A list of capacity providers in your account.
        NextMarker:
          type: string
          description: The pagination token that's included if more results are available.
      required:
      - CapacityProviders
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
          description: The number of seconds the caller should wait before retrying.
        Type:
          type: string
        message:
          type: string
        Reason:
          type: string
          enum:
          - ConcurrentInvocationLimitExceeded
          - FunctionInvocationRateLimitExceeded
          - ReservedFunctionConcurrentInvocationLimitExceeded
          - ReservedFunctionInvocationRateLimitExceeded
          - CallerRateLimitExceeded
          - ConcurrentSnapshotCreateLimitExceeded
    UpdateCapacityProviderRequest:
      type: object
      properties:
        CapacityProviderName:
          type: string
          description: The name of the capacity provider to update.
        CapacityProviderScalingConfig:
          $ref: '#/components/schemas/CapacityProviderScalingConfig'
        PropagateTags:
          $ref: '#/components/schemas/PropagateTags'
        TelemetryConfig:
          $ref: '#/components/schemas/CapacityProviderTelemetryConfig'
      required:
      - CapacityProviderName
    CapacityProviderVpcConfig:
      type: object
      properties:
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs where the capacity provider launches compute instances.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of security group IDs that control network access for compute instances managed by the capacity provider.
      required:
      - SubnetIds
      - SecurityGroupIds
    CapacityProviderLimitExceededException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
    CapacityProviderScalingConfig:
      type: object
      properties:
        MaxVCpuCount:
          type: integer
          description: The maximum number of vCPUs that the capacity provider can provision across all compute instances.
        ScalingMode:
          type: string
          enum:
          - Auto
          - Manual
          description: The scaling mode that determines how the capacity provider responds to changes in demand.
        ScalingPolicies:
          type: array
          items:
            $ref: '#/components/schemas/TargetTrackingScalingPolicy'
          description: A list of scaling policies that define how the capacity provider scales compute instances based on metrics and thresholds.
    ResourceNotFoundException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
    ServiceException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
    ListCapacityProvidersRequest:
      type: object
      properties:
        State:
          type: string
          enum:
          - Pending
          - Active
          - Failed
          - Deleting
          description: Filter capacity providers by their current state.
        Marker:
          type: string
          description: Specify the pagination token that's returned by a previous request to retrieve the next page of results.
        MaxItems:
          type: integer
          description: The maximum number of capacity providers to return.
    ResourceConflictException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    DeleteCapacityProviderRequest:
      type: object
      properties:
        CapacityProviderName:
          type: string
          description: The name of the capacity provider to delete.
      required:
      - CapacityProviderName
    CreateCapacityProviderRequest:
      type: object
      properties:
        CapacityProviderName:
          type: string
          description: The name of the capacity provider.
        VpcConfig:
          $ref: '#/components/schemas/CapacityProviderVpcConfig'
        PermissionsConfig:
          $ref: '#/components/schemas/CapacityProviderPermissionsConfig'
        InstanceRequirements:
          $ref: '#/components/schemas/InstanceRequirements'
        CapacityProviderScalingConfig:
          $ref: '#/components/schemas/CapacityProviderScalingConfig'
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key used to encrypt data associated with the capacity provider.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags to associate with the capacity provider.
        PropagateTags:
          $ref: '#/components/schemas/PropagateTags'
        TelemetryConfig:
          $ref: '#/components/schemas/CapacityProviderTelemetryConfig'
      required:
      - CapacityProviderName
      - VpcConfig
      - PermissionsConfig
    CapacityProviderLoggingConfig:
      type: object
      properties:
        SystemLogLevel:
          type: string
          enum:
          - DEBUG
          - INFO
          - WARN
          description: Set this property to filter the system logs for your capacity provider that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.
        LogGroup:
          type: string
          description: The name of the Amazon CloudWatch log group the capacity provider sends logs to. By default, Lambda capacity providers send logs to a default log group named /aws/lambda/capacity-provider/<capacity provider name>. To use a different log group, enter an existing log group or enter a new log group name.
    CapacityProviderTelemetryConfig:
      type: object
      properties:
        LoggingConfig:
          $ref: '#/components/schemas/CapacityProviderLoggingConfig'
    TargetTrackingScalingPolicy:
      type: object
      properties:
        PredefinedMetricType:
          type: string
          enum:
          - LambdaCapacityProviderAverageCPUUtilization
          description: The predefined metric type to track for scaling decisions.
        TargetValue:
          type: number
          description: The target value for the metric that the scaling policy attempts to maintain through scaling actions.
      required:
      - PredefinedMetricType
      - TargetValue
    DeleteCapacityProviderResponse:
      type: object
      properties:
        CapacityProvider:
          $ref: '#/components/schemas/CapacityProvider'
      required:
      - CapacityProvider
    PropagateTags:
      type: object
      properties:
        Mode:
          type: string
          enum:
          - None
          - Explicit
          description: The tag propagation mode. Set to Explicit to propagate the tags specified in ExplicitTags to managed resources. Set to None to disable tag propagation.
        ExplicitTags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags to apply to managed resources when Mode is set to Explicit. You can specify up to 40 tags.
    CapacityProviderPermissionsConfig:
      type: object
      properties:
        CapacityProviderOperatorRoleArn:
          type: string
          description: The ARN of the IAM role that the capacity provider uses to manage compute instances and other Amazon Web Services resources.
      required:
      - CapacityProviderOperatorRoleArn
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lambda
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lambda/service/2015-03-31/lambda-2015-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)