[ aws . glacier ]

list-provisioned-capacity

Description

This operation lists the provisioned capacity units for the specified AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-provisioned-capacity
--account-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single ‘-‘ (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don’t include any hyphens (‘-‘) in the ID.

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

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve the provisioned capacity units

The following list-provisioned-capacity example retrieves details for any provisioned capacity units for the specified account.

aws glacier list-provisioned-capacity \
    --account-id 111122223333

Output:

{
    "ProvisionedCapacityList": [
        {
            "CapacityId": "HpASAuvfRFiVDbOjMfEIcr8K",
            "ExpirationDate": "2020-03-18T19:59:24.000Z",
            "StartDate": "2020-02-18T19:59:24.912Z"
        }
    ]
}

Output

ProvisionedCapacityList -> (list)

The response body contains the following JSON fields.

(structure)

The definition for a provisioned capacity unit.

CapacityId -> (string)

The ID that identifies the provisioned capacity unit.

StartDate -> (string)

The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).

ExpirationDate -> (string)

The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).