2019/03/05
- AWS Storage Gateway -
6 updated api methods
Changes
ActivateGateway, CreateNFSFileShare and CreateSMBFileShare APIs support a new parameter: Tags (to be attached to the created resource). Output for DescribeNFSFileShare, DescribeSMBFileShare and DescribeGatewayInformation APIs now also list the Tags associated with the resource. Minimum length of a KMSKey is now 7 characters.
ActivateGateway (updated)
Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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
client.activate_gateway(
ActivationKey='string',
GatewayName='string',
GatewayTimezone='string',
GatewayRegion='string',
GatewayType='string',
TapeDriveType='string',
MediumChangerType='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
- type ActivationKey
string
- param ActivationKey
[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.
- type GatewayName
string
- param GatewayName
[REQUIRED]
The name you configured for your gateway.
- type GatewayTimezone
string
- param GatewayTimezone
[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.
- type GatewayRegion
string
- param GatewayRegion
[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: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.
- type GatewayType
string
- param GatewayType
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 CACHED .
Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
- type TapeDriveType
string
- param TapeDriveType
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: "IBM-ULT3580-TD5"
- type MediumChangerType
string
- param MediumChangerType
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"
- type Tags
list
- param Tags
A list of up to ten (10) tags assigned to the gateway may be specified. Every 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 (String). The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
- rtype
dict
- returns
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.
CreateNFSFileShare (updated)
Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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 for file gateways.
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
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,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
- type ClientToken
string
- param ClientToken
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
- type NFSFileShareDefaults
dict
- param NFSFileShareDefaults
File share default values. Optional.
FileMode (string) --
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.
DirectoryMode (string) --
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.
GroupId (integer) --
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
OwnerId (integer) --
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
- type KMSEncrypted
boolean
- param KMSEncrypted
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.
- type KMSKey
string
- param KMSKey
The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
- type Role
string
- param Role
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
- type LocationARN
string
- param LocationARN
[REQUIRED]
The ARN of the backed storage used for storing file data.
- type DefaultStorageClass
string
- param DefaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the 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.
- type ObjectACL
string
- param ObjectACL
A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
- type ClientList
list
- param ClientList
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
- type Squash
string
- param Squash
Maps a user to anonymous user. Valid options are the following:
RootSquash - Only root is mapped to anonymous user.
NoSquash - No one is mapped to anonymous user
AllSquash - Everyone is mapped to anonymous user.
- type ReadOnly
boolean
- param ReadOnly
A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
- type GuessMIMETypeEnabled
boolean
- param GuessMIMETypeEnabled
A value that 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.
- type RequesterPays
boolean
- param RequesterPays
A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private .
- type Tags
list
- param Tags
A list of up to ten (10) tags can be assigned to the NFS file share. Every 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 (String). The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
CreateSMBFileShare (updated)
Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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 for file gateways.
Warning
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS 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 gateways don't support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
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',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
- type ClientToken
string
- param ClientToken
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
- type KMSEncrypted
boolean
- param KMSEncrypted
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.
- type KMSKey
string
- param KMSKey
The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
- type Role
string
- param Role
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
- type LocationARN
string
- param LocationARN
[REQUIRED]
The ARN of the backed storage used for storing file data.
- type DefaultStorageClass
string
- param DefaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the 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.
- type ObjectACL
string
- param ObjectACL
A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
- type ReadOnly
boolean
- param ReadOnly
A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
- type GuessMIMETypeEnabled
boolean
- param GuessMIMETypeEnabled
A value that 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.
- type RequesterPays
boolean
- param RequesterPays
A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private .
- type ValidUserList
list
- param ValidUserList
A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1 . Can only be set if Authentication is set to ActiveDirectory .
- type InvalidUserList
list
- param InvalidUserList
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1 . Can only be set if Authentication is set to ActiveDirectory .
- type Authentication
string
- param Authentication
The authentication method that users use to access the file share.
Valid values are ActiveDirectory or GuestAccess . The default is ActiveDirectory .
- type Tags
list
- param Tags
A list of up to ten (10) tags can be assigned to the NFS file share. Every 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 (String). The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
DescribeGatewayInformation (updated)
Link ¶
Changes (response)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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
client.describe_gateway_information(
GatewayARN='string'
)
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
- rtype
dict
- returns
Response Syntax
{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayName': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string',
'LastSoftwareUpdate': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
DescribeNFSFileShares (updated)
Link ¶
Changes (response)
{'NFSFileShareInfoList': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
client.describe_nfs_file_shares(
FileShareARNList=[
'string',
]
)
- type FileShareARNList
list
- param FileShareARNList
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
- rtype
dict
- returns
Response Syntax
{
'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,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
DescribeSMBFileShares (updated)
Link ¶
Changes (response)
{'SMBFileShareInfoList': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
client.describe_smb_file_shares(
FileShareARNList=[
'string',
]
)
- type FileShareARNList
list
- param FileShareARNList
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
- rtype
dict
- returns
Response Syntax
{
'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure