Skip to content

Get Capacity Provider

lambda_get_capacity_provider R Documentation

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

Description

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

Usage

lambda_get_capacity_provider(CapacityProviderName)

Arguments

CapacityProviderName

[required] The name of the capacity provider to retrieve.

Value

A list with the following syntax:

list(
  CapacityProvider = list(
    CapacityProviderArn = "string",
    State = "Pending"|"Active"|"Failed"|"Deleting",
    VpcConfig = list(
      SubnetIds = list(
        "string"
      ),
      SecurityGroupIds = list(
        "string"
      )
    ),
    PermissionsConfig = list(
      CapacityProviderOperatorRoleArn = "string"
    ),
    InstanceRequirements = list(
      Architectures = list(
        "x86_64"|"arm64"
      ),
      AllowedInstanceTypes = list(
        "string"
      ),
      ExcludedInstanceTypes = list(
        "string"
      )
    ),
    CapacityProviderScalingConfig = list(
      MaxVCpuCount = 123,
      ScalingMode = "Auto"|"Manual",
      ScalingPolicies = list(
        list(
          PredefinedMetricType = "LambdaCapacityProviderAverageCPUUtilization",
          TargetValue = 123.0
        )
      )
    ),
    KmsKeyArn = "string",
    LastModified = "string"
  )
)

Request syntax

svc$get_capacity_provider(
  CapacityProviderName = "string"
)