Table of Contents
A low-level client representing AWS Storage Gateway:
client = session.create_client('storagegateway')
These are the available methods:
Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation .
Note
You must turn on the gateway VM before you can activate your gateway.
See also: AWS API Documentation
Request Syntax
response = client.activate_gateway(
ActivationKey='string',
GatewayName='string',
GatewayTimezone='string',
GatewayRegion='string',
GatewayType='string',
TapeDriveType='string',
MediumChangerType='string'
)
[REQUIRED]
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey . It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.
[REQUIRED]
The name you configured for your gateway.
[REQUIRED]
A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
[REQUIRED]
A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary .
Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"
A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED .
Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: "IBM-ULT3580-TD5"
The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: "STK-L700", "AWS-Gateway-VTL"
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
Note
For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Activates the gateway you previously deployed on your host.
response = client.activate_gateway(
ActivationKey='29AV1-3OFV9-VVIUB-NKT0I-LRO6V',
GatewayName='My_Gateway',
GatewayRegion='us-east-1',
GatewayTimezone='GMT-12:00',
GatewayType='STORED',
MediumChangerType='AWS-Gateway-VTL',
TapeDriveType='IBM-ULT3580-TD5',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts ).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
See also: AWS API Documentation
Request Syntax
response = client.add_cache(
GatewayARN='string',
DiskIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
dict
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 region.
Examples
The following example shows a request that activates a gateway-stored volume.
response = client.add_cache(
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': {
'...': '...',
},
}
Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to add tags to.
[REQUIRED]
The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
AddTagsToResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource you want to add tags to.
Examples
Adds one or more tags to the specified resource.
response = client.add_tags_to_resource(
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
Tags=[
{
'Key': 'Dev Gatgeway Region',
'Value': 'East Coast',
},
],
)
print(response)
Expected Output:
{
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
See also: AWS API Documentation
Request Syntax
response = client.add_upload_buffer(
GatewayARN='string',
DiskIds=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
dict
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 region.
Examples
Configures one or more gateway local disks as upload buffer for a specified gateway.
response = client.add_upload_buffer(
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': {
'...': '...',
},
}
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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the 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 region.
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': {
'...': '...',
},
}
Check if an operation can be paginated.
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.cancel_archival(
GatewayARN='string',
TapeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelArchivalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
Examples
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
response = client.cancel_archival(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
'ResponseMetadata': {
'...': '...',
},
}
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.cancel_retrieval(
GatewayARN='string',
TapeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CancelRetrievalOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
Examples
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
response = client.cancel_retrieval(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
'ResponseMetadata': {
'...': '...',
},
}
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.
Note
Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
See also: AWS API Documentation
Request Syntax
response = client.create_cached_iscsi_volume(
GatewayARN='string',
VolumeSizeInBytes=123,
SnapshotId='string',
TargetName='string',
SourceVolumeARN='string',
NetworkInterfaceId='string',
ClientToken='string',
KMSEncrypted=True|False,
KMSKey='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The size of the volume in bytes.
[REQUIRED]
The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
[REQUIRED]
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
dict
Response Syntax
{
'VolumeARN': 'string',
'TargetARN': 'string'
}
Response Structure
(dict) --
VolumeARN (string) --
The Amazon Resource Name (ARN) of the configured volume.
TargetARN (string) --
he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
Examples
Creates a cached volume on a specified cached gateway.
response = client.create_cached_iscsi_volume(
ClientToken='cachedvol112233',
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
NetworkInterfaceId='10.1.1.1',
SnapshotId='snap-f47b7b94',
TargetName='my-volume',
VolumeSizeInBytes=536870912000,
)
print(response)
Expected Output:
{
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported in the file gateway type.
Warning
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.create_nfs_file_share(
ClientToken='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False
)
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
File share default values. Optional.
The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.
The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
[REQUIRED]
The ARN of the backed storage used for storing file data.
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
Maps a user to anonymous user. Valid options are the following:
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported in the file gateway type.
Warning
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.create_smb_file_share(
ClientToken='string',
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
],
Authentication='string'
)
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
[REQUIRED]
The ARN of the backed storage used for storing file data.
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule .
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference .
Warning
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
VolumeARN='string',
SnapshotDescription='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
[REQUIRED]
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
dict
Response Syntax
{
'VolumeARN': 'string',
'SnapshotId': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
SnapshotId (string) --
The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or creating a volume from a snapshot ( CreateStorediSCSIVolume ).
Examples
Initiates an ad-hoc snapshot of a gateway volume.
response = client.create_snapshot(
SnapshotDescription='My root volume snapshot as of 10/03/2017',
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'SnapshotId': 'snap-78e22663',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints .
In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference .
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot_from_volume_recovery_point(
VolumeARN='string',
SnapshotDescription='string'
)
dict
Response Syntax
{
'SnapshotId': 'string',
'VolumeARN': 'string',
'VolumeRecoveryPointTime': 'string'
}
Response Structure
Examples
Initiates a snapshot of a gateway from a volume recovery point.
response = client.create_snapshot_from_volume_recovery_point(
SnapshotDescription='My root volume snapshot as of 2017-06-30T10:10:10.000Z',
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'SnapshotId': 'snap-78e22663',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeRecoveryPointTime': '2017-06-30T10:10:10.000Z',
'ResponseMetadata': {
'...': '...',
},
}
Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.
In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
See also: AWS API Documentation
Request Syntax
response = client.create_stored_iscsi_volume(
GatewayARN='string',
DiskId='string',
SnapshotId='string',
PreserveExistingData=True|False,
TargetName='string',
NetworkInterfaceId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
[REQUIRED]
Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values: true, false
[REQUIRED]
The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
[REQUIRED]
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
dict
Response Syntax
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'TargetARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
VolumeARN (string) --
The Amazon Resource Name (ARN) of the configured volume.
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
TargetARN (string) --
he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
Examples
Creates a stored volume on a specified stored gateway.
response = client.create_stored_iscsi_volume(
DiskId='pci-0000:03:00.0-scsi-0:0:0:0',
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
NetworkInterfaceId='10.1.1.1',
PreserveExistingData=True,
SnapshotId='snap-f47b7b94',
TargetName='my-volume',
)
print(response)
Expected Output:
{
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeSizeInBytes': 1099511627776,
'ResponseMetadata': {
'...': '...',
},
}
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Note
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_tape_with_barcode(
GatewayARN='string',
TapeSizeInBytes=123,
TapeBarcode='string',
KMSEncrypted=True|False,
KMSKey='string'
)
[REQUIRED]
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The size, in bytes, of the virtual tape that you want to create.
Note
The size must be aligned by gigabyte (1024*1024*1024 byte).
[REQUIRED]
The barcode that you want to assign to the tape.
Note
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
CreateTapeOutput
TapeARN (string) --
A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
Examples
Creates a virtual tape by using your own barcode.
response = client.create_tape_with_barcode(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeBarcode='TEST12345',
TapeSizeInBytes=107374182400,
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345',
'ResponseMetadata': {
'...': '...',
},
}
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
Note
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_tapes(
GatewayARN='string',
TapeSizeInBytes=123,
ClientToken='string',
NumTapesToCreate=123,
TapeBarcodePrefix='string',
KMSEncrypted=True|False,
KMSKey='string'
)
[REQUIRED]
The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The size, in bytes, of the virtual tapes that you want to create.
Note
The size must be aligned by gigabyte (1024*1024*1024 byte).
[REQUIRED]
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Note
Using the same ClientToken prevents creating the tape multiple times.
[REQUIRED]
The number of virtual tapes that you want to create.
[REQUIRED]
A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.
dict
Response Syntax
{
'TapeARNs': [
'string',
]
}
Response Structure
(dict) --
CreateTapeOutput
TapeARNs (list) --
A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
Examples
Creates one or more virtual tapes.
response = client.create_tapes(
ClientToken='77777',
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
NumTapesToCreate=3,
TapeBarcodePrefix='TEST',
TapeSizeInBytes=107374182400,
)
print(response)
Expected Output:
{
'TapeARNs': [
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D',
'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F',
'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E',
],
'ResponseMetadata': {
'...': '...',
},
}
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.delete_bandwidth_rate_limit(
GatewayARN='string',
BandwidthType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.
Valid Values: Upload , Download , All .
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose bandwidth rate information was deleted.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
response = client.delete_bandwidth_rate_limit(
BandwidthType='All',
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': {
'...': '...',
},
}
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
See also: AWS API Documentation
Request Syntax
response = client.delete_chap_credentials(
TargetARN='string',
InitiatorName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
[REQUIRED]
The iSCSI initiator that connects to the target.
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target.
InitiatorName (string) --
The iSCSI initiator that connects to the target.
Examples
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
response = client.delete_chap_credentials(
InitiatorName='iqn.1991-05.com.microsoft:computername.domain.example.com',
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'ResponseMetadata': {
'...': '...',
},
}
Deletes a file share from a file gateway. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.delete_file_share(
FileShareARN='string',
ForceDelete=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be deleted.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
DeleteFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the deleted file share.
Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
Warning
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page .
See also: AWS API Documentation
Request Syntax
response = client.delete_gateway(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the ID of the deleted gateway.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
This operation deletes the gateway, but not the gateway's VM from the host computer.
response = client.delete_gateway(
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': {
'...': '...',
},
}
Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots . In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference .
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot_schedule(
VolumeARN='string'
)
{
'VolumeARN': 'string'
}
Response Structure
Examples
This action enables you to delete a snapshot schedule for a volume.
response = client.delete_snapshot_schedule(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.delete_tape(
GatewayARN='string',
TapeARN='string'
)
[REQUIRED]
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the deleted virtual tape.
Examples
This example deletes the specified virtual tape.
response = client.delete_tape(
GatewayARN='arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.delete_tape_archive(
TapeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
{
'TapeARN': 'string'
}
Response Structure
DeleteTapeArchiveOutput
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
Examples
Deletes the specified virtual tape from the virtual tape shelf (VTS).
response = client.delete_tape_archive(
TapeARN='arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0',
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
See also: AWS API Documentation
Request Syntax
response = client.delete_volume(
VolumeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
{
'VolumeARN': 'string'
}
Response Structure
A JSON object containing the of the storage volume that was deleted
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
Examples
Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
response = client.delete_volume(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.describe_bandwidth_rate_limit(
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 region.
{
'GatewayARN': 'string',
'AverageUploadRateLimitInBitsPerSec': 123,
'AverageDownloadRateLimitInBitsPerSec': 123
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
Examples
Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
response = client.describe_bandwidth_rate_limit(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'AverageDownloadRateLimitInBitsPerSec': 204800,
'AverageUploadRateLimitInBitsPerSec': 102400,
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
See also: AWS API Documentation
Request Syntax
response = client.describe_cache(
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 region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'CacheAllocatedInBytes': 123,
'CacheUsedPercentage': 123.0,
'CacheDirtyPercentage': 123.0,
'CacheHitPercentage': 123.0,
'CacheMissPercentage': 123.0
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Returns information about the cache of a gateway.
response = client.describe_cache(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'CacheAllocatedInBytes': 2199023255552,
'CacheDirtyPercentage': 0.07,
'CacheHitPercentage': 99.68,
'CacheMissPercentage': 0.32,
'CacheUsedPercentage': 0.07,
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
response = client.describe_cached_iscsi_volumes(
VolumeARNs=[
'string',
]
)
[REQUIRED]
{
'CachediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'SourceSnapshotId': 'string',
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
},
'CreatedDate': datetime(2015, 1, 1),
'VolumeUsedInBytes': 123,
'KMSKey': 'string'
},
]
}
Response Structure
A JSON object containing the following fields:
An array of objects where each object contains metadata about one cached volume.
Describes an iSCSI cached volume.
The Amazon Resource Name (ARN) of the storage volume.
The unique identifier of the volume, e.g. vol-AE4B946D.
One of the VolumeType enumeration values that describes the type of the volume.
One of the VolumeStatus values that indicates the state of the storage volume.
The size, in bytes, of the volume capacity.
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.
If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
The Amazon Resource Name (ARN) of the volume target.
The network interface identifier.
The port used to communicate with iSCSI targets.
The logical disk number.
Indicates whether mutual CHAP is enabled for the iSCSI target.
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
The size of the data stored on the volume in bytes.
Note
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
Examples
Returns a description of the gateway cached iSCSI volumes specified in the request.
response = client.describe_cached_iscsi_volumes(
VolumeARNs=[
'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
],
)
print(response)
Expected Output:
{
'CachediSCSIVolumes': [
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 1099511627776,
'VolumeStatus': 'AVAILABLE',
'VolumeType': 'CACHED iSCSI',
'VolumeiSCSIAttributes': {
'ChapEnabled': True,
'LunNumber': 1,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
See also: AWS API Documentation
Request Syntax
response = client.describe_chap_credentials(
TargetARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
{
'ChapCredentials': [
{
'TargetARN': 'string',
'SecretToAuthenticateInitiator': 'string',
'InitiatorName': 'string',
'SecretToAuthenticateTarget': 'string'
},
]
}
Response Structure
A JSON object containing a .
An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
The iSCSI initiator that connects to the target.
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Examples
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
response = client.describe_chap_credentials(
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'ChapCredentials': [
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'SecretToAuthenticateInitiator': '111111111111',
'SecretToAuthenticateTarget': '222222222222',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.describe_gateway_information(
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 region.
{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayName': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string',
'LastSoftwareUpdate': 'string'
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
The name you configured for your gateway.
A value that indicates the time zone configured for the gateway.
A value that indicates the operating state of the gateway.
A NetworkInterface array that contains descriptions of the gateway network interfaces.
Describes a gateway's network interface.
The Internet Protocol version 4 (IPv4) address of the interface.
The Media Access Control (MAC) address of the interface.
Note
This is currently unsupported and will not be returned in output.
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported .
The type of the gateway.
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
Examples
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
response = client.describe_gateway_information(
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',
'GatewayId': 'sgw-AABB1122',
'GatewayName': 'My_Gateway',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': '10.35.69.216',
},
],
'GatewayState': 'STATE_RUNNING',
'GatewayTimezone': 'GMT-8:00',
'GatewayType': 'STORED',
'LastSoftwareUpdate': '2016-01-02T16:00:00',
'NextUpdateAvailabilityDate': '2017-01-02T16:00:00',
'ResponseMetadata': {
'...': '...',
},
}
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
See also: AWS API Documentation
Request Syntax
response = client.describe_maintenance_start_time(
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 region.
{
'GatewayARN': 'string',
'HourOfDay': 123,
'MinuteOfHour': 123,
'DayOfWeek': 123,
'Timezone': 'string'
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
The hour component of the maintenance start time represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
The minute component of the maintenance start time represented as mm , where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
Examples
Returns your gateway's weekly maintenance start time including the day and time of the week.
response = client.describe_maintenance_start_time(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DayOfWeek': 2,
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'HourOfDay': 15,
'MinuteOfHour': 35,
'Timezone': 'GMT+7:00',
'ResponseMetadata': {
'...': '...',
},
}
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_nfs_file_shares(
FileShareARNList=[
'string',
]
)
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
The Amazon Resource Name (ARN) of the file share.
{
'NFSFileShareInfoList': [
{
'NFSFileShareDefaults': {
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ClientList': [
'string',
],
'Squash': 'string',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False
},
]
}
Response Structure
DescribeNFSFileSharesOutput
An array containing a description for each requested file share.
The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.
Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway type.
The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.
The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
The Amazon Resource Name (ARN) of the file share.
The ID of the file share.
The status of the file share. Possible values are CREATING , UPDATING , AVAILABLE and DELETING .
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
The file share path used by the NFS client to identify the mount point.
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
The ARN of the backend storage used for storing file data.
The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
The user mapped to anonymous user. Valid options are the following:
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_smb_file_shares(
FileShareARNList=[
'string',
]
)
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
The Amazon Resource Name (ARN) of the file share.
{
'SMBFileShareInfoList': [
{
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False,
'ValidUserList': [
'string',
],
'InvalidUserList': [
'string',
],
'Authentication': 'string'
},
]
}
Response Structure
DescribeSMBFileSharesOutput
An array containing a description for each requested file share.
The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.
The Amazon Resource Name (ARN) of the file share.
The ID of the file share.
The status of the file share. Possible values are CREATING , UPDATING , AVAILABLE and DELETING .
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
The file share path used by the SMB client to identify the mount point.
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
The ARN of the backend storage used for storing file data.
The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
The authentication method of the file share. Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_smb_settings(
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 region.
{
'GatewayARN': 'string',
'DomainName': 'string',
'SMBGuestPasswordSet': True|False
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
The name of the domain that the gateway is joined to.
This value is true if a password for the guest user “smbguest” is set, and otherwise false.
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshot_schedule(
VolumeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
{
'VolumeARN': 'string',
'StartAt': 123,
'RecurrenceInHours': 123,
'Description': 'string',
'Timezone': 'string'
}
Response Structure
Examples
Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.
response = client.describe_snapshot_schedule(
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'Description': 'sgw-AABB1122:vol-AABB1122:Schedule',
'RecurrenceInHours': 24,
'StartAt': 6,
'Timezone': 'GMT+7:00',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_stored_iscsi_volumes(
VolumeARNs=[
'string',
]
)
[REQUIRED]
An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
{
'StorediSCSIVolumes': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'VolumeType': 'string',
'VolumeStatus': 'string',
'VolumeSizeInBytes': 123,
'VolumeProgress': 123.0,
'VolumeDiskId': 'string',
'SourceSnapshotId': 'string',
'PreservedExistingData': True|False,
'VolumeiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'LunNumber': 123,
'ChapEnabled': True|False
},
'CreatedDate': datetime(2015, 1, 1),
'VolumeUsedInBytes': 123
},
]
}
Response Structure
Describes an iSCSI stored volume.
The Amazon Resource Name (ARN) of the storage volume.
The unique identifier of the volume, e.g. vol-AE4B946D.
One of the VolumeType enumeration values describing the type of the volume.
One of the VolumeStatus values that indicates the state of the storage volume.
The size of the volume in bytes.
Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true, false
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
The Amazon Resource Name (ARN) of the volume target.
The network interface identifier.
The port used to communicate with iSCSI targets.
The logical disk number.
Indicates whether mutual CHAP is enabled for the iSCSI target.
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
The size of the data stored on the volume in bytes.
Note
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
Examples
Returns the description of the gateway volumes specified in the request belonging to the same gateway.
response = client.describe_stored_iscsi_volumes(
VolumeARNs=[
'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
],
)
print(response)
Expected Output:
{
'StorediSCSIVolumes': [
{
'PreservedExistingData': False,
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeDiskId': 'pci-0000:03:00.0-scsi-0:0:0:0',
'VolumeId': 'vol-1122AABB',
'VolumeProgress': 23.7,
'VolumeSizeInBytes': 1099511627776,
'VolumeStatus': 'BOOTSTRAPPING',
'VolumeiSCSIAttributes': {
'ChapEnabled': True,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_tape_archives(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
dict
Response Syntax
{
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string',
'TapeUsedInBytes': 123,
'KMSKey': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeArchivesOutput
TapeArchives (list) --
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
(dict) --
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
TapeARN (string) --
The Amazon Resource Name (ARN) of an archived virtual tape.
TapeBarcode (string) --
The barcode that identifies the archived virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the archived virtual tape.
CompletionTime (datetime) --
The time that the archiving of the virtual tape was completed.
The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
RetrievedTo (string) --
The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeStatus (string) --
The current state of the archived virtual tape.
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
Marker (string) --
An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
Examples
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
response = client.describe_tape_archives(
Limit=123,
Marker='1',
TapeARNs=[
'arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD',
'arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4',
],
)
print(response)
Expected Output:
{
'Marker': '1',
'TapeArchives': [
{
'CompletionTime': datetime(2016, 12, 16, 13, 50, 0, 4, 351, 0),
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD',
'TapeBarcode': 'AM08A1AD',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'ARCHIVED',
},
{
'CompletionTime': datetime(2016, 12, 16, 13, 59, 0, 4, 351, 0),
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
'TapeBarcode': 'AMZN01A2A4',
'TapeSizeInBytes': 429496729600,
'TapeStatus': 'ARCHIVED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_tape_recovery_points(
GatewayARN='string',
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapeRecoveryPointsOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
TapeRecoveryPointInfos (list) --
An array of TapeRecoveryPointInfos that are available for the specified gateway.
(dict) --
Describes a recovery point.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeRecoveryPointTime (datetime) --
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tapes to recover.
TapeStatus (string) --
Marker (string) --
An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
Examples
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
response = client.describe_tape_recovery_points(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
Limit=1,
Marker='1',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'Marker': '1',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4',
'TapeRecoveryPointTime': datetime(2016, 12, 16, 13, 50, 0, 4, 351, 0),
'TapeSizeInBytes': 1471550497,
'TapeStatus': 'AVAILABLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_tapes(
GatewayARN='string',
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
A marker value, obtained in a previous call to DescribeTapes . This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
Specifies that the number of virtual tapes described be limited to the specified number.
Note
Amazon Web Services may impose its own limit, if this field is not set.
dict
Response Syntax
{
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0,
'TapeUsedInBytes': 123,
'KMSKey': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeTapesOutput
Tapes (list) --
An array of virtual tape descriptions.
(dict) --
Describes a virtual tape object.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape capacity.
TapeStatus (string) --
The current state of the virtual tape.
VTLDevice (string) --
The virtual tape library (VTL) device that the virtual tape is associated with.
Progress (float) --
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
Marker (string) --
An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
Examples
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.
response = client.describe_tapes(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
Limit=2,
Marker='1',
TapeARNs=[
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
],
)
print(response)
Expected Output:
{
'Marker': '1',
'Tapes': [
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1',
'TapeBarcode': 'TEST04A2A1',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'AVAILABLE',
},
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0',
'TapeBarcode': 'TEST05A2A0',
'TapeSizeInBytes': 107374182400,
'TapeStatus': 'AVAILABLE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
See also: AWS API Documentation
Request Syntax
response = client.describe_upload_buffer(
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 region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'UploadBufferUsedInBytes': 123,
'UploadBufferAllocatedInBytes': 123
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.
response = client.describe_upload_buffer(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'UploadBufferAllocatedInBytes': 0,
'UploadBufferUsedInBytes': 161061273600,
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.
response = client.describe_upload_buffer(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'DiskIds': [
'pci-0000:03:00.0-scsi-0:0:0:0',
'pci-0000:04:00.0-scsi-0:1:0:0',
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'UploadBufferAllocatedInBytes': 161061273600,
'UploadBufferUsedInBytes': 0,
'ResponseMetadata': {
'...': '...',
},
}
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.describe_vtl_devices(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
Note
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
dict
Response Syntax
{
'GatewayARN': 'string',
'VTLDevices': [
{
'VTLDeviceARN': 'string',
'VTLDeviceType': 'string',
'VTLDeviceVendor': 'string',
'VTLDeviceProductIdentifier': 'string',
'DeviceiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'ChapEnabled': True|False
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DescribeVTLDevicesOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
VTLDevices (list) --
An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
(dict) --
Represents a device object associated with a tape gateway.
VTLDeviceARN (string) --
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
VTLDeviceType (string) --
VTLDeviceVendor (string) --
VTLDeviceProductIdentifier (string) --
DeviceiSCSIAttributes (dict) --
A list of iSCSI information about a VTL device.
TargetARN (string) --
Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
NetworkInterfaceId (string) --
The network interface identifier of the VTL device.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI VTL device targets.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
Marker (string) --
An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
Examples
Returns a description of virtual tape library (VTL) devices for the specified gateway.
response = client.describe_vtl_devices(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
Limit=123,
Marker='1',
VTLDeviceARNs=[
],
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'Marker': '1',
'VTLDevices': [
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.207',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
'VTLDeviceProductIdentifier': 'L700',
'VTLDeviceType': 'Medium Changer',
'VTLDeviceVendor': 'STK',
},
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.209',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001',
'VTLDeviceProductIdentifier': 'ULT3580-TD5',
'VTLDeviceType': 'Tape Drive',
'VTLDeviceVendor': 'IBM',
},
{
'DeviceiSCSIAttributes': {
'ChapEnabled': False,
'NetworkInterfaceId': '10.243.43.209',
'NetworkInterfacePort': 3260,
'TargetARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02',
},
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002',
'VTLDeviceProductIdentifier': 'ULT3580-TD5',
'VTLDeviceType': 'Tape Drive',
'VTLDeviceVendor': 'IBM',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.
Note
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
See also: AWS API Documentation
Request Syntax
response = client.describe_working_storage(
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 region.
{
'GatewayARN': 'string',
'DiskIds': [
'string',
],
'WorkingStorageUsedInBytes': 123,
'WorkingStorageAllocatedInBytes': 123
}
Response Structure
A JSON object containing the following fields:
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
Examples
This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
response = client.describe_working_storage(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'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',
'WorkingStorageAllocatedInBytes': 2199023255552,
'WorkingStorageUsedInBytes': 789207040,
'ResponseMetadata': {
'...': '...',
},
}
Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
Warning
Once a gateway is disabled it cannot be enabled.
See also: AWS API Documentation
Request Syntax
response = client.disable_gateway(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
DisableGatewayOutput
The unique Amazon Resource Name of the disabled gateway.
Examples
Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.
response = client.disable_gateway(
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': {
'...': '...',
},
}
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Adds a file gateway to an Active Directory domain. This operation is only supported in the file gateway type that supports the SMB file protocol.
See also: AWS API Documentation
Request Syntax
response = client.join_domain(
GatewayARN='string',
DomainName='string',
UserName='string',
Password='string'
)
[REQUIRED]
The unique Amazon Resource Name of the file gateway you want to add to the Active Directory domain.
[REQUIRED]
The name of the domain that you want the gateway to join.
[REQUIRED]
Sets the user name of user who has permission to add the gateway to the Active Directory domain.
[REQUIRED]
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
JoinDomainOutput
GatewayARN (string) --
The unique Amazon Resource Name of the gateway that joined the domain.
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.list_file_shares(
GatewayARN='string',
Limit=123,
Marker='string'
)
dict
Response Syntax
{
'Marker': 'string',
'NextMarker': 'string',
'FileShareInfoList': [
{
'FileShareType': 'NFS'|'SMB',
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string'
},
]
}
Response Structure
(dict) --
ListFileShareOutput
Marker (string) --
If the request includes Marker , the response returns that value in this field.
NextMarker (string) --
If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.
FileShareInfoList (list) --
An array of information about the file gateway's file shares.
(dict) --
Describes a file share.
FileShareType (string) --
The type of the file share.
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share. Possible values are CREATING , UPDATING , AVAILABLE and DELETING .
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
See also: AWS API Documentation
Request Syntax
response = client.list_gateways(
Marker='string',
Limit=123
)
dict
Response Syntax
{
'Gateways': [
{
'GatewayId': 'string',
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string',
'GatewayName': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Gateways (list) --
(dict) --
Describes a gateway object.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayType (string) --
The type of the gateway.
GatewayOperationalState (string) --
The state of the gateway.
Valid Values: DISABLED or ACTIVE
GatewayName (string) --
The name of the gateway.
Marker (string) --
Examples
Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.
response = client.list_gateways(
Limit=2,
Marker='1',
)
print(response)
Expected Output:
{
'Gateways': [
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
},
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C',
},
],
'Marker': '1',
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
See also: AWS API Documentation
Request Syntax
response = client.list_local_disks(
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 region.
{
'GatewayARN': 'string',
'Disks': [
{
'DiskId': 'string',
'DiskPath': 'string',
'DiskNode': 'string',
'DiskStatus': 'string',
'DiskSizeInBytes': 123,
'DiskAllocationType': 'string',
'DiskAllocationResource': 'string'
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all.
response = client.list_local_disks(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'Disks': [
{
'DiskAllocationType': 'CACHE_STORAGE',
'DiskId': 'pci-0000:03:00.0-scsi-0:0:0:0',
'DiskNode': 'SCSI(0:0)',
'DiskPath': '/dev/sda',
'DiskSizeInBytes': 1099511627776,
'DiskStatus': 'missing',
},
{
'DiskAllocationResource': '',
'DiskAllocationType': 'UPLOAD_BUFFER',
'DiskId': 'pci-0000:03:00.0-scsi-0:0:1:0',
'DiskNode': 'SCSI(0:1)',
'DiskPath': '/dev/sdb',
'DiskSizeInBytes': 1099511627776,
'DiskStatus': 'present',
},
],
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string',
Marker='string',
Limit=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
dict
Response Syntax
{
'ResourceARN': 'string',
'Marker': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ListTagsForResourceOutput
ResourceARN (string) --
he Amazon Resource Name (ARN) of the resource for which you want to list tags.
Marker (string) --
An opaque string that indicates the position at which to stop returning the list of tags.
Tags (list) --
An array that contains the tags for the specified resource.
Examples
Lists the tags that have been added to the specified resource.
response = client.list_tags_for_resource(
Limit=1,
Marker='1',
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
)
print(response)
Expected Output:
{
'Marker': '1',
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'Tags': [
{
'Key': 'Dev Gatgeway Region',
'Value': 'East Coast',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.list_tapes(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.
dict
Response Syntax
{
'TapeInfos': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'GatewayARN': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TapeInfos (list) --
An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.
(dict) --
Describes a virtual tape.
TapeARN (string) --
The Amazon Resource Name (ARN) of a virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeSizeInBytes (integer) --
The size, in bytes, of a virtual tape.
TapeStatus (string) --
The status of the tape.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Marker (string) --
A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
See also: AWS API Documentation
Request Syntax
response = client.list_volume_initiators(
VolumeARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
{
'Initiators': [
'string',
]
}
Response Structure
ListVolumeInitiatorsOutput
The host names and port numbers of all iSCSI initiators that are connected to the gateway.
Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.
Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
See also: AWS API Documentation
Request Syntax
response = client.list_volume_recovery_points(
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 region.
{
'GatewayARN': 'string',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'string',
'VolumeSizeInBytes': 123,
'VolumeUsageInBytes': 123,
'VolumeRecoveryPointTime': 'string'
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.
response = client.list_volume_recovery_points(
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',
'VolumeRecoveryPointInfos': [
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeRecoveryPointTime': '2012-09-04T21:08:44.627Z',
'VolumeSizeInBytes': 536870912000,
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
See also: AWS API Documentation
Request Syntax
response = client.list_volumes(
GatewayARN='string',
Marker='string',
Limit=123
)
dict
Response Syntax
{
'GatewayARN': 'string',
'Marker': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'GatewayARN': 'string',
'GatewayId': 'string',
'VolumeType': 'string',
'VolumeSizeInBytes': 123
},
]
}
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 region.
Marker (string) --
VolumeInfos (list) --
(dict) --
Describes a storage volume object.
VolumeARN (string) --
The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeId (string) --
The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeType (string) --
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Examples
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.
response = client.list_volumes(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
Limit=2,
Marker='1',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'Marker': '1',
'VolumeInfos': [
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'GatewayId': 'sgw-12A3456B',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 107374182400,
'VolumeType': 'STORED',
},
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
'GatewayId': 'sgw-gw-13B4567C',
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD',
'VolumeId': 'vol-1122AABB',
'VolumeSizeInBytes': 107374182400,
'VolumeType': 'STORED',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.
AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported in the file gateway type.
For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
See also: AWS API Documentation
Request Syntax
response = client.notify_when_uploaded(
FileShareARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share.
{
'FileShareARN': 'string',
'NotificationId': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the file share.
The randomly generated ID of the notification that was sent. This ID is in UUID format.
Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type.
See also: AWS API Documentation
Request Syntax
response = client.refresh_cache(
FileShareARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share.
{
'FileShareARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the file share.
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
[REQUIRED]
The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
RemoveTagsFromResourceOutput
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource that the tags were removed from.
Examples
Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.
response = client.remove_tags_from_resource(
ResourceARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
TagKeys=[
'Dev Gatgeway Region',
'East Coast',
],
)
print(response)
Expected Output:
{
'ResourceARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B',
'ResponseMetadata': {
'...': '...',
},
}
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
Warning
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
See also: AWS API Documentation
Request Syntax
response = client.reset_cache(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.
response = client.reset_cache(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
'ResponseMetadata': {
'...': '...',
},
}
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.retrieve_tape_archive(
TapeARN='string',
GatewayARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the retrieved virtual tape.
Examples
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.
response = client.retrieve_tape_archive(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
'ResponseMetadata': {
'...': '...',
},
}
Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
Note
The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.
See also: AWS API Documentation
Request Syntax
response = client.retrieve_tape_recovery_point(
TapeARN='string',
GatewayARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
RetrieveTapeRecoveryPointOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
Examples
Retrieves the recovery point for the specified virtual tape.
response = client.retrieve_tape_recovery_point(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
TapeARN='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
)
print(response)
Expected Output:
{
'TapeARN': 'arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF',
'ResponseMetadata': {
'...': '...',
},
}
Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
See also: AWS API Documentation
Request Syntax
response = client.set_local_console_password(
GatewayARN='string',
LocalConsolePassword='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The password you want to set for your VM local console.
dict
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 region.
Examples
Sets the password for your VM local console.
response = client.set_local_console_password(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
LocalConsolePassword='PassWordMustBeAtLeast6Chars.',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Sets the password for the guest user “smbguest”. "smbguest" is the user when the Authentication method for the file share is “GuestAccess”.
See also: AWS API Documentation
Request Syntax
response = client.set_smb_guest_password(
GatewayARN='string',
Password='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with.
[REQUIRED]
The password you want to set for your SMB Server.
dict
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 region.
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
Note
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway , DescribeGatewayInformation , and ListGateways . For more information, see ActivateGateway . Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
Note
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway .
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway ) to no longer pay software charges associated with the gateway.
See also: AWS API Documentation
Request Syntax
response = client.shutdown_gateway(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the of the gateway that was shut down.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
response = client.shutdown_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Starts a gateway that you previously shut down (see ShutdownGateway ). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
Note
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway .
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.start_gateway(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the of the gateway that was restarted.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Starts a gateway service that was previously shut down.
response = client.start_gateway(
GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
response = client.update_bandwidth_rate_limit(
GatewayARN='string',
AverageUploadRateLimitInBitsPerSec=123,
AverageDownloadRateLimitInBitsPerSec=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose throttle information was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.
response = client.update_bandwidth_rate_limit(
AverageDownloadRateLimitInBitsPerSec=102400,
AverageUploadRateLimitInBitsPerSec=51200,
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': {
'...': '...',
},
}
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.
Warning
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
See also: AWS API Documentation
Request Syntax
response = client.update_chap_credentials(
TargetARN='string',
SecretToAuthenticateInitiator='string',
InitiatorName='string',
SecretToAuthenticateTarget='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
[REQUIRED]
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
Note
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
[REQUIRED]
The iSCSI initiator that connects to the target.
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
Note
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
dict
Response Syntax
{
'TargetARN': 'string',
'InitiatorName': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
TargetARN (string) --
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
InitiatorName (string) --
The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
Examples
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
response = client.update_chap_credentials(
InitiatorName='iqn.1991-05.com.microsoft:computername.domain.example.com',
SecretToAuthenticateInitiator='111111111111',
SecretToAuthenticateTarget='222222222222',
TargetARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
)
print(response)
Expected Output:
{
'InitiatorName': 'iqn.1991-05.com.microsoft:computername.domain.example.com',
'TargetARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume',
'ResponseMetadata': {
'...': '...',
},
}
Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Note
For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_information(
GatewayARN='string',
GatewayName='string',
GatewayTimezone='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
dict
Response Syntax
{
'GatewayARN': 'string',
'GatewayName': 'string'
}
Response Structure
(dict) --
A JSON object containing the ARN of the gateway that was updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayName (string) --
Examples
Updates a gateway's metadata, which includes the gateway's name and time zone.
response = client.update_gateway_information(
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
GatewayName='MyGateway2',
GatewayTimezone='GMT-12:00',
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'GatewayName': '',
'ResponseMetadata': {
'...': '...',
},
}
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
Note
When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.
Warning
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings , respectively.
See also: AWS API Documentation
Request Syntax
response = client.update_gateway_software_now(
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 region.
{
'GatewayARN': 'string'
}
Response Structure
A JSON object containing the of the gateway that was updated.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
response = client.update_gateway_software_now(
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': {
'...': '...',
},
}
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
See also: AWS API Documentation
Request Syntax
response = client.update_maintenance_start_time(
GatewayARN='string',
HourOfDay=123,
MinuteOfHour=123,
DayOfWeek=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
[REQUIRED]
The hour component of the maintenance start time represented as hh , where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
[REQUIRED]
The minute component of the maintenance start time represented as mm , where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
[REQUIRED]
The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the gateway whose maintenance start time is updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Examples
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.
response = client.update_maintenance_start_time(
DayOfWeek=2,
GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
HourOfDay=0,
MinuteOfHour=30,
)
print(response)
Expected Output:
{
'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
'ResponseMetadata': {
'...': '...',
},
}
Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share setting:
Note
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.
See also: AWS API Documentation
Request Syntax
response = client.update_nfs_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be updated.
The default values for the file share. Optional.
The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.
The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
The user mapped to anonymous user. Valid options are the following:
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated file share.
Updates a Server Message Block (SMB) file share. This operation is only supported in the file gateway type.
Note
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in the file gateway type.
Warning
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
response = client.update_smb_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB file share you want to update.
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated SMB file share.
Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
See also: AWS API Documentation
Request Syntax
response = client.update_snapshot_schedule(
VolumeARN='string',
StartAt=123,
RecurrenceInHours=123,
Description='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
[REQUIRED]
The hour of the day at which the snapshot schedule begins represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
[REQUIRED]
Frequency of snapshots. Specify the number of hours between snapshots.
dict
Response Syntax
{
'VolumeARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the of the updated storage volume.
Examples
Updates a snapshot schedule configured for a gateway volume.
response = client.update_snapshot_schedule(
Description='Hourly snapshot',
RecurrenceInHours=1,
StartAt=0,
VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)
print(response)
Expected Output:
{
'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
'ResponseMetadata': {
'...': '...',
},
}
Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
response = client.update_vtl_device_type(
VTLDeviceARN='string',
DeviceType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the medium changer you want to select.
[REQUIRED]
The type of medium changer you want to select.
Valid Values: "STK-L700", "AWS-Gateway-VTL"
dict
Response Syntax
{
'VTLDeviceARN': 'string'
}
Response Structure
(dict) --
UpdateVTLDeviceTypeOutput
VTLDeviceARN (string) --
The Amazon Resource Name (ARN) of the medium changer you have selected.
Examples
Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.
response = client.update_vtl_device_type(
DeviceType='Medium Changer',
VTLDeviceARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
)
print(response)
Expected Output:
{
'VTLDeviceARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001',
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('describe_tape_archives')
Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tape_archives().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TapeArchives': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'CompletionTime': datetime(2015, 1, 1),
'RetrievedTo': 'string',
'TapeStatus': 'string',
'TapeUsedInBytes': 123,
'KMSKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapeArchivesOutput
TapeArchives (list) --
An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
(dict) --
Represents a virtual tape that is archived in the virtual tape shelf (VTS).
TapeARN (string) --
The Amazon Resource Name (ARN) of an archived virtual tape.
TapeBarcode (string) --
The barcode that identifies the archived virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the archived virtual tape.
CompletionTime (datetime) --
The time that the archiving of the virtual tape was completed.
The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
RetrievedTo (string) --
The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
TapeStatus (string) --
The current state of the archived virtual tape.
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_tape_recovery_points')
Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tape_recovery_points().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GatewayARN': 'string',
'TapeRecoveryPointInfos': [
{
'TapeARN': 'string',
'TapeRecoveryPointTime': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapeRecoveryPointsOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
TapeRecoveryPointInfos (list) --
An array of TapeRecoveryPointInfos that are available for the specified gateway.
(dict) --
Describes a recovery point.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeRecoveryPointTime (datetime) --
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tapes to recover.
TapeStatus (string) --
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_tapes')
Creates an iterator that will paginate through responses from StorageGateway.Client.describe_tapes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
TapeARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tapes': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeCreatedDate': datetime(2015, 1, 1),
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'VTLDevice': 'string',
'Progress': 123.0,
'TapeUsedInBytes': 123,
'KMSKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeTapesOutput
Tapes (list) --
An array of virtual tape descriptions.
(dict) --
Describes a virtual tape object.
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape.
TapeBarcode (string) --
The barcode that identifies a specific virtual tape.
TapeCreatedDate (datetime) --
The date the virtual tape was created.
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape capacity.
TapeStatus (string) --
The current state of the virtual tape.
VTLDevice (string) --
The virtual tape library (VTL) device that the virtual tape is associated with.
Progress (float) --
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
TapeUsedInBytes (integer) --
The size, in bytes, of data stored on the virtual tape.
Note
This value is not available for tapes created prior to May 13, 2015.
KMSKey (string) --
The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_vtl_devices')
Creates an iterator that will paginate through responses from StorageGateway.Client.describe_vtl_devices().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
VTLDeviceARNs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
Note
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GatewayARN': 'string',
'VTLDevices': [
{
'VTLDeviceARN': 'string',
'VTLDeviceType': 'string',
'VTLDeviceVendor': 'string',
'VTLDeviceProductIdentifier': 'string',
'DeviceiSCSIAttributes': {
'TargetARN': 'string',
'NetworkInterfaceId': 'string',
'NetworkInterfacePort': 123,
'ChapEnabled': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DescribeVTLDevicesOutput
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
VTLDevices (list) --
An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
(dict) --
Represents a device object associated with a tape gateway.
VTLDeviceARN (string) --
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
VTLDeviceType (string) --
VTLDeviceVendor (string) --
VTLDeviceProductIdentifier (string) --
DeviceiSCSIAttributes (dict) --
A list of iSCSI information about a VTL device.
TargetARN (string) --
Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
NetworkInterfaceId (string) --
The network interface identifier of the VTL device.
NetworkInterfacePort (integer) --
The port used to communicate with iSCSI VTL device targets.
ChapEnabled (boolean) --
Indicates whether mutual CHAP is enabled for the iSCSI target.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_gateways')
Creates an iterator that will paginate through responses from StorageGateway.Client.list_gateways().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Gateways': [
{
'GatewayId': 'string',
'GatewayARN': 'string',
'GatewayType': 'string',
'GatewayOperationalState': 'string',
'GatewayName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Describes a gateway object.
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
The type of the gateway.
The state of the gateway.
Valid Values: DISABLED or ACTIVE
The name of the gateway.
A token to resume pagination.
paginator = client.get_paginator('list_volumes')
Creates an iterator that will paginate through responses from StorageGateway.Client.list_volumes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GatewayARN='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GatewayARN': 'string',
'VolumeInfos': [
{
'VolumeARN': 'string',
'VolumeId': 'string',
'GatewayARN': 'string',
'GatewayId': 'string',
'VolumeType': 'string',
'VolumeSizeInBytes': 123
},
],
'NextToken': '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 region.
VolumeInfos (list) --
(dict) --
Describes a storage volume object.
VolumeARN (string) --
The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeId (string) --
The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
GatewayId (string) --
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
VolumeType (string) --
VolumeSizeInBytes (integer) --
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
NextToken (string) --
A token to resume pagination.