AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-reserved-capacity

Description

Retrieves details about a reserved capacity.

See also: AWS API Documentation

Synopsis

  describe-reserved-capacity
--reserved-capacity-arn <value>
[--cli-input-json <value>]
[--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>]

Options

--reserved-capacity-arn (string)

ARN of the reserved capacity to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

ReservedCapacityArn -> (string)

ARN of the reserved capacity.

ReservedCapacityType -> (string)

The type of reserved capacity.

Status -> (string)

The current status of the reserved capacity.

AvailabilityZone -> (string)

The Availability Zone where the reserved capacity is provisioned.

DurationHours -> (long)

The total duration of the reserved capacity in hours.

DurationMinutes -> (long)

The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

StartTime -> (timestamp)

The timestamp when the reserved capacity becomes active.

EndTime -> (timestamp)

The timestamp when the reserved capacity expires.

InstanceType -> (string)

The Amazon EC2 instance type used in the reserved capacity.

TotalInstanceCount -> (integer)

The total number of instances allocated to this reserved capacity.

AvailableInstanceCount -> (integer)

The number of instances currently available for use in this reserved capacity.

InUseInstanceCount -> (integer)

The number of instances currently in use from this reserved capacity.

UltraServerSummary -> (structure)

A summary of the UltraServer associated with this reserved capacity.

UltraServerType -> (string)

The type of UltraServer, such as ml.u-p6e-gb200x72.

InstanceType -> (string)

The Amazon EC2 instance type used in the UltraServer.

UltraServerCount -> (integer)

The number of UltraServers of this type.

AvailableSpareInstanceCount -> (integer)

The number of available spare instances in the UltraServers.

UnhealthyInstanceCount -> (integer)

The total number of instances across all UltraServers of this type that are currently in an unhealthy state.