[ aws . lambda ]

get-capacity-provider

Description

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

See also: AWS API Documentation

Synopsis

  get-capacity-provider
--capacity-provider-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--capacity-provider-name (string) [required]

The name of the capacity provider to retrieve.

Constraints:

• min: 1
• max: 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-_]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

CapacityProvider -> (structure)

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

CapacityProviderArn -> (string) [required]

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

Constraints:

• min: 1
• max: 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-_]+

State -> (string) [required]

The current state of the capacity provider.

Possible values:

• Pending
• Active
• Failed
• Deleting

VpcConfig -> (structure) [required]

The VPC configuration for the capacity provider.

SubnetIds -> (list) [required]

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

Constraints:

• min: 1
• max: 16

(string)

SecurityGroupIds -> (list) [required]

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

Constraints:

• min: 0
• max: 5

(string)

PermissionsConfig -> (structure) [required]

The permissions configuration for the capacity provider.

CapacityProviderOperatorRoleArn -> (string) [required]

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

Constraints:

• pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

InstanceRequirements -> (structure)

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 .

Constraints:

• min: 1
• max: 1

(string)

Possible values:

• x86_64
• arm64

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.

Constraints:

• min: 0
• max: 400

(string)

Constraints:

• min: 1
• max: 30
• pattern: [a-zA-Z0-9\.\-]+

ExcludedInstanceTypes -> (list)

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

Constraints:

• min: 0
• max: 400

(string)

Constraints:

• min: 1
• max: 30
• pattern: [a-zA-Z0-9\.\-]+

CapacityProviderScalingConfig -> (structure)

The scaling configuration for the capacity provider.

MaxVCpuCount -> (integer)

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

Constraints:

• min: 2
• max: 15000

ScalingMode -> (string)

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

Possible values:

• Auto
• Manual

ScalingPolicies -> (list)

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

Constraints:

• min: 1
• max: 10

(structure)

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

PredefinedMetricType -> (string) [required]

The predefined metric type to track for scaling decisions.

Possible values:

• LambdaCapacityProviderAverageCPUUtilization

TargetValue -> (double) [required]

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

Constraints:

• min: 0.0
• max: 100.0

KmsKeyArn -> (string)

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

Constraints:

• pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()

LastModified -> (string)

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