add_working_storage

add_working_storage(**kwargs)

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

Note

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

See also: AWS API Documentation

Request Syntax

response = client.add_working_storage(
    GatewayARN='string',
    DiskIds=[
        'string',
    ]
)

Parameters

• GatewayARN (string) --

  [REQUIRED]

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

• DiskIds (list) --

  [REQUIRED]

  An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

  • (string) --

Return type

dict

Returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.

  • GatewayARN (string) --

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

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException
• StorageGateway.Client.exceptions.InternalServerError

Examples

Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)

response = client.add_working_storage(
    DiskIds=[
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'ResponseMetadata': {
        '...': '...',
    },
}