Glacier / Client / list_provisioned_capacity

list_provisioned_capacity#

Glacier.Client.list_provisioned_capacity(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_provisioned_capacity(

)
Parameters:

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

Note: this parameter is set to “-” bydefault if no value is not specified.

Return type:

dict

Returns:

Response Syntax

{
    'ProvisionedCapacityList': [
        {
            'CapacityId': 'string',
            'StartDate': 'string',
            'ExpirationDate': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ProvisionedCapacityList (list) –

      The response body contains the following JSON fields.

      • (dict) –

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

Exceptions

  • Glacier.Client.exceptions.InvalidParameterValueException

  • Glacier.Client.exceptions.MissingParameterValueException

  • Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example lists the provisioned capacity units for an account.

response = client.list_provisioned_capacity(
    accountId='-',
)

print(response)

Expected Output:

{
    'ProvisionedCapacityList': [
        {
            'CapacityId': 'zSaq7NzHFQDANTfQkDen4V7z',
            'ExpirationDate': '2016-12-12T00:00:00.000Z',
            'StartDate': '2016-11-11T20:11:51.095Z',
        },
        {
            'CapacityId': 'yXaq7NzHFQNADTfQkDen4V7z',
            'ExpirationDate': '2017-01-15T00:00:00.000Z',
            'StartDate': '2016-12-13T20:11:51.095Z',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}