2020/08/19 - AWS Storage Gateway - 3 new 10 updated api methods
Changes Added WORM, tape retention lock, and custom pool features for virtual tapes.
Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools 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 tape pools.
See also: AWS API Documentation
Request Syntax
client.list_tape_pools(
PoolARNs=[
'string',
],
Marker='string',
Limit=123
)
list
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
(string) --
string
A string that indicates the position at which to begin the returned list of tape pools.
integer
An optional number limit for the tape pools in the list returned by this call.
dict
Response Syntax
{
'PoolInfos': [
{
'PoolARN': 'string',
'PoolName': 'string',
'StorageClass': 'DEEP_ARCHIVE'|'GLACIER',
'RetentionLockType': 'COMPLIANCE'|'GOVERNANCE'|'NONE',
'RetentionLockTimeInDays': 123,
'PoolStatus': 'ACTIVE'|'DELETED'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
PoolInfos (list) --
An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.
(dict) --
Describes a custom tape pool.
PoolARN (string) --
The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and AWS Region.
PoolName (string) --
The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and ''.
StorageClass (string) --
The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
RetentionLockType (string) --
Tape retention lock type, which can be configured in two modes. When configured in governance mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account.
RetentionLockTimeInDays (integer) --
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
PoolStatus (string) --
Status of the custom tape pool. Pool can be ACTIVE or DELETED .
Marker (string) --
A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.
Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
See also: AWS API Documentation
Request Syntax
client.delete_tape_pool(
PoolARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the custom tape pool to delete.
dict
Response Syntax
{
'PoolARN': 'string'
}
Response Structure
(dict) --
PoolARN (string) --
The Amazon Resource Name (ARN) of the custom tape pool being deleted.
Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
See also: AWS API Documentation
Request Syntax
client.create_tape_pool(
PoolName='string',
StorageClass='DEEP_ARCHIVE'|'GLACIER',
RetentionLockType='COMPLIANCE'|'GOVERNANCE'|'NONE',
RetentionLockTimeInDays=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the new custom tape pool.
string
[REQUIRED]
The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
string
Tape retention lock can be configured in two modes. When configured in governance mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account.
integer
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
list
A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
Tag key. The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
dict
Response Syntax
{
'PoolARN': 'string'
}
Response Structure
(dict) --
PoolARN (string) --
The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and AWS Region.
{'BypassGovernanceRetention': 'boolean'}
Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
See also: AWS API Documentation
Request Syntax
client.assign_tape_pool(
TapeARN='string',
PoolId='string',
BypassGovernanceRetention=True|False
)
string
[REQUIRED]
The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.
string
[REQUIRED]
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
boolean
Set permissions to bypass governance retention. If the lock type of the archived tape is Governance , the tape's archived age is not older than RetentionLockInDays , and the user does not already have BypassGovernanceRetention , setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.
Valid values: TRUE | FALSE
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
TapeARN (string) --
The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.
{'Worm': 'boolean'}
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 cannot 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
client.create_tape_with_barcode(
GatewayARN='string',
TapeSizeInBytes=123,
TapeBarcode='string',
KMSEncrypted=True|False,
KMSKey='string',
PoolId='string',
Worm=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
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 AWS Region.
integer
[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 bytes).
string
[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.
boolean
Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
string
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
boolean
Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
list
A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
Tag key. The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
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.
{'Worm': 'boolean'}
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
client.create_tapes(
GatewayARN='string',
TapeSizeInBytes=123,
ClientToken='string',
NumTapesToCreate=123,
TapeBarcodePrefix='string',
KMSEncrypted=True|False,
KMSKey='string',
PoolId='string',
Worm=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
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 AWS Region.
integer
[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 bytes).
string
[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.
integer
[REQUIRED]
The number of virtual tapes that you want to create.
string
[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.
boolean
Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
string
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
boolean
Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
list
A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
Tag key. The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
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.
(string) --
{'BypassGovernanceRetention': 'boolean'}
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
See also: AWS API Documentation
Request Syntax
client.delete_tape(
GatewayARN='string',
TapeARN='string',
BypassGovernanceRetention=True|False
)
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 AWS Region.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete.
boolean
Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the deleted virtual tape.
{'BypassGovernanceRetention': 'boolean'}
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
client.delete_tape_archive(
TapeARN='string',
BypassGovernanceRetention=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
boolean
Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.
dict
Response Syntax
{
'TapeARN': 'string'
}
Response Structure
(dict) --
DeleteTapeArchiveOutput
TapeARN (string) --
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
{'TapeArchives': {'PoolEntryDate': 'timestamp',
'RetentionStartDate': 'timestamp',
'Worm': 'boolean'}}
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
client.describe_tape_archives(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
list
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
(string) --
string
An opaque string that indicates the position at which to begin describing virtual tapes.
integer
Specifies that the number of virtual tapes described be limited to the specified number.
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',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'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 timestamp 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 a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
Worm (boolean) --
Set to true if the archived tape is stored as write-once-read-many (WORM).
RetentionStartDate (datetime) --
If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
PoolEntryDate (datetime) --
The time that the tape entered the custom tape pool.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
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.
{'Tapes': {'PoolEntryDate': 'timestamp',
'RetentionStartDate': 'timestamp',
'Worm': 'boolean'}}
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
client.describe_tapes(
GatewayARN='string',
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
list
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.
(string) --
string
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.
integer
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',
'PoolId': 'string',
'Worm': True|False,
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'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 a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
PoolId (string) --
The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
Worm (boolean) --
If the tape is archived as write-once-read-many (WORM), this value is true .
RetentionStartDate (datetime) --
The date that the tape is first archived with tape retention lock enabled.
PoolEntryDate (datetime) --
The date that the tape enters a custom tape pool.
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.
{'AutomaticTapeCreationPolicyInfos': {'AutomaticTapeCreationRules': {'Worm': 'boolean'}}}
Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
See also: AWS API Documentation
Request Syntax
client.list_automatic_tape_creation_policies(
GatewayARN='string'
)
string
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
dict
Response Syntax
{
'AutomaticTapeCreationPolicyInfos': [
{
'AutomaticTapeCreationRules': [
{
'TapeBarcodePrefix': 'string',
'PoolId': 'string',
'TapeSizeInBytes': 123,
'MinimumNumTapes': 123,
'Worm': True|False
},
],
'GatewayARN': 'string'
},
]
}
Response Structure
(dict) --
AutomaticTapeCreationPolicyInfos (list) --
Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
(dict) --
Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
AutomaticTapeCreationRules (list) --
An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.
(dict) --
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.
TapeBarcodePrefix (string) --
A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
PoolId (string) --
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
TapeSizeInBytes (integer) --
The size, in bytes, of the virtual tape capacity.
MinimumNumTapes (integer) --
The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.
Worm (boolean) --
Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
{'TapeInfos': {'PoolEntryDate': 'timestamp', 'RetentionStartDate': 'timestamp'}}
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
client.list_tapes(
TapeARNs=[
'string',
],
Marker='string',
Limit=123
)
list
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.
(string) --
string
A string that indicates the position at which to begin the returned list of tapes.
integer
An optional number limit for the tapes in the list returned by this call.
dict
Response Syntax
{
'TapeInfos': [
{
'TapeARN': 'string',
'TapeBarcode': 'string',
'TapeSizeInBytes': 123,
'TapeStatus': 'string',
'GatewayARN': 'string',
'PoolId': 'string',
'RetentionStartDate': datetime(2015, 1, 1),
'PoolEntryDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
A JSON object containing the following fields:
ListTapesOutput$Marker
ListTapesOutput$VolumeInfos
TapeInfos (list) --
An array of TapeInfo objects, where each object describes a single tape. If there are no 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 AWS Region.
PoolId (string) --
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
RetentionStartDate (datetime) --
The date that the tape became subject to tape retention lock.
PoolEntryDate (datetime) --
The date that the tape entered the custom tape pool with tape retention lock enabled.
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.
{'AutomaticTapeCreationRules': {'Worm': 'boolean'}}
Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
Note
A gateway can have only one automatic tape creation policy.
See also: AWS API Documentation
Request Syntax
client.update_automatic_tape_creation_policy(
AutomaticTapeCreationRules=[
{
'TapeBarcodePrefix': 'string',
'PoolId': 'string',
'TapeSizeInBytes': 123,
'MinimumNumTapes': 123,
'Worm': True|False
},
],
GatewayARN='string'
)
list
[REQUIRED]
An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.
(dict) --
An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.
TapeBarcodePrefix (string) -- [REQUIRED]
A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
Note
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
PoolId (string) -- [REQUIRED]
The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
Valid Values: GLACIER | DEEP_ARCHIVE
TapeSizeInBytes (integer) -- [REQUIRED]
The size, in bytes, of the virtual tape capacity.
MinimumNumTapes (integer) -- [REQUIRED]
The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.
Worm (boolean) --
Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
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 AWS Region.