AWS Storage Gateway

2020/04/23 - AWS Storage Gateway - 3 new api methods

Changes  Added AutomaticTapeCreation APIs

DeleteAutomaticTapeCreationPolicy (new) Link ¶

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

See also: AWS API Documentation

Request Syntax

client.delete_automatic_tape_creation_policy(
    GatewayARN='string'
)
type GatewayARN

string

param GatewayARN

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) --

    • GatewayARN (string) --

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

ListAutomaticTapeCreationPolicies (new) Link ¶

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

This operation is only supported for tape gateways.

See also: AWS API Documentation

Request Syntax

client.list_automatic_tape_creation_policies(
    GatewayARN='string'
)
type GatewayARN

string

param GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

rtype

dict

returns

Response Syntax

{
    'AutomaticTapeCreationPolicyInfos': [
        {
            'AutomaticTapeCreationRules': [
                {
                    'TapeBarcodePrefix': 'string',
                    'PoolId': 'string',
                    'TapeSizeInBytes': 123,
                    'MinimumNumTapes': 123
                },
            ],
            'GatewayARN': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • AutomaticTapeCreationPolicyInfos (list) --

      Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

      • (dict) --

        Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

        • AutomaticTapeCreationRules (list) --

          An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.

          • (dict) --

            An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes.

            • TapeBarcodePrefix (string) --

              A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.

              Note

              The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

            • PoolId (string) --

              The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

              Valid values: "GLACIER", "DEEP_ARCHIVE"

            • TapeSizeInBytes (integer) --

              The size, in bytes, of the virtual tape capacity.

            • MinimumNumTapes (integer) --

              The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway.

        • GatewayARN (string) --

          The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

UpdateAutomaticTapeCreationPolicy (new) Link ¶

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

By default, there is no automatic tape creation policy.

Note

A gateway can have only one automatic tape creation policy.

See also: AWS API Documentation

Request Syntax

client.update_automatic_tape_creation_policy(
    AutomaticTapeCreationRules=[
        {
            'TapeBarcodePrefix': 'string',
            'PoolId': 'string',
            'TapeSizeInBytes': 123,
            'MinimumNumTapes': 123
        },
    ],
    GatewayARN='string'
)
type AutomaticTapeCreationRules

list

param AutomaticTapeCreationRules

[REQUIRED]

An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

  • (dict) --

    An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes.

    • TapeBarcodePrefix (string) -- [REQUIRED]

      A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.

      Note

      The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

    • PoolId (string) -- [REQUIRED]

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

    • TapeSizeInBytes (integer) -- [REQUIRED]

      The size, in bytes, of the virtual tape capacity.

    • MinimumNumTapes (integer) -- [REQUIRED]

      The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway.

type GatewayARN

string

param GatewayARN

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) --

    • GatewayARN (string) --

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.