String activationKey
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 Getting activation key in the Storage Gateway User Guide.
String gatewayName
The name you configured for your gateway.
String gatewayTimezone
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.
String gatewayRegion
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web
Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your
Host header in the request. For more information about available Amazon Web Services Regions and
endpoints for Storage Gateway, see Storage
Gateway endpoints and quotas in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
String 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 |
FILE_FSX_SMB|
String tapeDriveType
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
String 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 | IBM-03584L32-0402
SdkInternalList<T> tags
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented 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 characters.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
String gatewayARN
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
SdkInternalList<T> tags
The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.
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.
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
String gatewayARN
SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
String gatewayARN
String tapeARN
The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.
String poolId
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 bypassGovernanceRetention
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
String tapeARN
The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.
String userName
The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
String password
The password of the user credential.
String clientToken
A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
String gatewayARN
String locationARN
The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for the audit logs.
CacheAttributes cacheAttributes
EndpointNetworkConfiguration endpointNetworkConfiguration
Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is
required.
String fileSystemAssociationARN
The ARN of the newly created file system association.
String gatewayARN
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
String targetName
The name of the iSCSI target used by an initiator to connect to a volume and used 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 on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
String volumeARN
The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
String networkInterfaceId
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.
String diskId
The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.
SdkInternalList<T> automaticTapeCreationRules
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.
String gatewayARN
String tapeBarcodePrefix
A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
String poolId
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
Long tapeSizeInBytes
The size, in bytes, of the virtual tape capacity.
Integer minimumNumTapes
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.
Boolean worm
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.
Integer startHourOfDay
The hour of the day to start the bandwidth rate limit interval.
Integer startMinuteOfHour
The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that
minute. To begin an interval exactly at the start of the hour, use the value 0.
Integer endHourOfDay
The hour of the day to end the bandwidth rate limit interval.
Integer endMinuteOfHour
The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use
the value 59.
SdkInternalList<T> daysOfWeek
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
Long averageUploadRateLimitInBitsPerSec
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
Long averageDownloadRateLimitInBitsPerSec
The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.
Integer cacheStaleTimeoutInSeconds
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
String volumeARN
The Amazon Resource Name (ARN) of the storage volume.
String volumeId
The unique identifier of the volume, e.g., vol-AE4B946D.
String volumeType
One of the VolumeType enumeration values that describes the type of the volume.
String volumeStatus
One of the VolumeStatus values that indicates the state of the storage volume.
String volumeAttachmentStatus
A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.
Long volumeSizeInBytes
The size, in bytes, of the volume capacity.
Double volumeProgress
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.
String sourceSnapshotId
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.
VolumeiSCSIAttributes volumeiSCSIAttributes
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
Date createdDate
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
Long volumeUsedInBytes
The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that
are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns
but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size
of the volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
String kMSKey
String targetName
The name of the iSCSI target used by an initiator to connect to a volume and used 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 on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
String targetARN
The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
String secretToAuthenticateInitiator
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
String initiatorName
The iSCSI initiator that connects to the target.
String secretToAuthenticateTarget
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client).
String gatewayARN
Long volumeSizeInBytes
The size of the volume in bytes.
String snapshotId
The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
String targetName
The name of the iSCSI target used by an initiator to connect to a volume and used 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 on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
String sourceVolumeARN
The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified
existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be
equal to or larger than the size of the existing volume, in bytes.
String networkInterfaceId
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.
String clientToken
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.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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.
SdkInternalList<T> tags
A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.
String clientToken
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
NFSFileShareDefaults nFSFileShareDefaults
File share default values. Optional.
String gatewayARN
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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 role
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
String locationARN
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into. The default value is private.
SdkInternalList<T> clientList
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
String squash
A value that maps a user to anonymous user.
Valid values 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.
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set the write status
to read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
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.
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Specifies refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
String vPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String bucketRegion
Specifies the Region of the S3 bucket where the NFS file share stores files.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String fileShareARN
The Amazon Resource Name (ARN) of the newly created file share.
String clientToken
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
String gatewayARN
The ARN of the S3 File Gateway on which you want to create a file share.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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 role
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
String locationARN
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into. The default value is private.
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set the write status
to read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Boolean sMBACLEnabled
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to
false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
Boolean accessBasedEnumeration
The files and folders on this share will only be visible to users with read access.
SdkInternalList<T> adminUserList
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share. These users can do all file operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
SdkInternalList<T> validUserList
SdkInternalList<T> 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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String authentication
The authentication method that users use to access the file share. The default is ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
String caseSensitivity
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the
case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value
is ClientSpecified.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
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.
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Specifies refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
String vPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String bucketRegion
Specifies the Region of the S3 bucket where the SMB file share stores files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Boolean oplocksEnabled
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
String fileShareARN
The Amazon Resource Name (ARN) of the newly created file share.
String volumeARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
String snapshotDescription
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
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.
String snapshotId
The ID of the snapshot.
String volumeARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
String volumeRecoveryPointTime
The time the volume was created from the recovery point.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String snapshotDescription
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
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.
String volumeARN
The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
String snapshotId
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).
String gatewayARN
String diskId
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
String snapshotId
The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
Boolean preserveExistingData
Set to true if you want to preserve the data on the local disk. Otherwise, set to false
to create an empty volume.
Valid Values: true | false
String targetName
The name of the iSCSI target used by an initiator to connect to a volume and used 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 on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
String networkInterfaceId
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.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.
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.
String volumeARN
The Amazon Resource Name (ARN) of the configured volume.
Long volumeSizeInBytes
The size of the volume in bytes.
String targetARN
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
String poolName
The name of the new custom tape pool.
String storageClass
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 retentionLockType
Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services 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 Amazon Web Services account.
Integer retentionLockTimeInDays
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair.
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.
String poolARN
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 Amazon Web Services Region.
String gatewayARN
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 Amazon Web Services Region.
Long tapeSizeInBytes
The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
String clientToken
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.
Using the same ClientToken prevents creating the tape multiple times.
Integer numTapesToCreate
The number of virtual tapes that you want to create.
String tapeBarcodePrefix
A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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 poolId
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 worm
Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.
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.
SdkInternalList<T> tapeARNs
A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
String gatewayARN
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 Amazon Web Services Region.
Long tapeSizeInBytes
The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
String tapeBarcode
The barcode that you want to assign to the tape.
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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 poolId
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 worm
Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
SdkInternalList<T> tags
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.
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.
String tapeARN
A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
String gatewayARN
String gatewayARN
String gatewayARN
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
String initiatorName
The iSCSI initiator that connects to the target.
String fileShareARN
The Amazon Resource Name (ARN) of the file share to be deleted.
Boolean forceDelete
If this value is set to true, the operation deletes a file share immediately and aborts all data
uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web
Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING
status.
Valid Values: true | false
String fileShareARN
The Amazon Resource Name (ARN) of the deleted file share.
String gatewayARN
String gatewayARN
String volumeARN
The volume which snapshot schedule to delete.
String volumeARN
The volume which snapshot schedule was deleted.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
Boolean bypassGovernanceRetention
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.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
String poolARN
The Amazon Resource Name (ARN) of the custom tape pool to delete.
String poolARN
The Amazon Resource Name (ARN) of the custom tape pool being deleted.
String gatewayARN
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 Amazon Web Services Region.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete.
Boolean bypassGovernanceRetention
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.
String tapeARN
The Amazon Resource Name (ARN) of the deleted virtual tape.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String volumeARN
The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
String gatewayARN
String gatewayARN
String status
The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.
Date startTime
The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.
String gatewayARN
String gatewayARN
Long averageUploadRateLimitInBitsPerSec
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.
Long averageDownloadRateLimitInBitsPerSec
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.
String gatewayARN
String gatewayARN
SdkInternalList<T> bandwidthRateLimitIntervals
An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
SdkInternalList<T> volumeARNs
An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
SdkInternalList<T> cachediSCSIVolumes
An array of objects where each object contains metadata about one cached volume.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
Long cacheAllocatedInBytes
The amount of cache in bytes allocated to a gateway.
Double cacheUsedPercentage
Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.
Double cacheDirtyPercentage
The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.
Double cacheHitPercentage
Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.
Double cacheMissPercentage
Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
SdkInternalList<T> chapCredentials
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:
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
SdkInternalList<T> fileSystemAssociationARNList
An array containing the Amazon Resource Name (ARN) of each file system association to be described.
SdkInternalList<T> fileSystemAssociationInfoList
An array containing the FileSystemAssociationInfo data type of each file system association to be
described.
String gatewayARN
String gatewayARN
String gatewayId
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.
String gatewayName
The name you configured for your gateway.
String gatewayTimezone
A value that indicates the time zone configured for the gateway.
String gatewayState
A value that indicates the operating state of the gateway.
SdkInternalList<T> gatewayNetworkInterfaces
A NetworkInterface array that contains descriptions of the gateway network interfaces.
String gatewayType
The type of the gateway.
String nextUpdateAvailabilityDate
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.
String lastSoftwareUpdate
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.
String ec2InstanceId
The ID of the Amazon EC2 instance that was used to launch the gateway.
String ec2InstanceRegion
The Amazon Web Services Region where the Amazon EC2 instance is located.
SdkInternalList<T> tags
A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair.
For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource
API operation.
String vPCEndpoint
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
String cloudWatchLogGroupARN
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.
String hostEnvironment
The type of hypervisor environment used by the host.
String endpointType
The type of endpoint for your gateway.
Valid Values: STANDARD | FIPS
String softwareUpdatesEndDate
Date after which this gateway will not receive software updates for new features.
String deprecationDate
Date after which this gateway will not receive software updates for new features and bug fixes.
String gatewayCapacity
Specifies the size of the gateway's metadata cache.
SdkInternalList<T> supportedGatewayCapacities
A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
String gatewayARN
String gatewayARN
Integer hourOfDay
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.
Integer minuteOfHour
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.
Integer dayOfWeek
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.
Integer dayOfMonth
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
String timezone
A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.
SdkInternalList<T> fileShareARNList
An array containing the Amazon Resource Name (ARN) of each file share to be described.
SdkInternalList<T> nFSFileShareInfoList
An array containing a description for each requested file share.
SdkInternalList<T> fileShareARNList
An array containing the Amazon Resource Name (ARN) of each file share to be described.
SdkInternalList<T> sMBFileShareInfoList
An array containing a description for each requested file share.
String gatewayARN
String gatewayARN
String domainName
The name of the domain that the gateway is joined to.
String activeDirectoryStatus
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication
error.
DETACHED: Indicates that gateway is not joined to a domain.
JOINED: Indicates that the gateway has successfully joined a domain.
JOINING: Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or
connectivity error.
TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of
error.
Boolean sMBGuestPasswordSet
This value is true if a password for the guest user smbguest is set, otherwise
false. Only supported for S3 File Gateways.
Valid Values: true | false
String sMBSecurityStrategy
The type of security strategy that was specified for file gateway.
ClientSpecified: If you use this option, requests are established based on what is negotiated by the
client. This option is recommended when you want to maximize compatibility across different clients in your
environment. Only supported for S3 File Gateways.
MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3
clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server
2008 or newer.
MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients
that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This
option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
Boolean fileSharesVisible
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
SMBLocalGroups sMBLocalGroups
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String volumeARN
The Amazon Resource Name (ARN) of the volume that was specified in the request.
Integer startAt
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.
Integer recurrenceInHours
The number of hours between snapshots.
String description
The snapshot description.
String timezone
A value that indicates the time zone of the gateway.
SdkInternalList<T> tags
A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
SdkInternalList<T> volumeARNs
An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
SdkInternalList<T> storediSCSIVolumes
Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.
LunNumber: The logical disk number.
NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the
stored volume as an iSCSI target.
NetworkInterfacePort: The port used to communicate with iSCSI targets.
PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying
local disk was preserved.
SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot
ID used, e.g. snap-1122aabb. Otherwise, this field is not included.
StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about
one stored volume.
TargetARN: The Amazon Resource Name (ARN) of the volume target.
VolumeARN: The Amazon Resource Name (ARN) of the stored volume.
VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume
operation.
VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.
VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI
attributes for one stored volume.
VolumeProgress: 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.
VolumeSizeInBytes: The size of the volume in bytes.
VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.
VolumeType: One of the enumeration values describing the type of the volume. Currently, only
STORED volumes are supported.
SdkInternalList<T> tapeARNs
Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
String marker
An opaque string that indicates the position at which to begin describing virtual tapes.
Integer limit
Specifies that the number of virtual tapes described be limited to the specified number.
SdkInternalList<T> tapeArchives
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.
String marker
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.
String gatewayARN
SdkInternalList<T> tapeRecoveryPointInfos
An array of TapeRecoveryPointInfos that are available for the specified gateway.
String marker
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.
String gatewayARN
SdkInternalList<T> tapeARNs
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 marker
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 limit
Specifies that the number of virtual tapes described be limited to the specified number.
Amazon Web Services may impose its own limit, if this field is not set.
SdkInternalList<T> tapes
An array of virtual tape descriptions.
String marker
An opaque string that 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.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
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.
Long uploadBufferUsedInBytes
The total number of bytes being used in the gateway's upload buffer.
Long uploadBufferAllocatedInBytes
The total number of bytes allocated in the gateway's as upload buffer.
String gatewayARN
SdkInternalList<T> vTLDeviceARNs
An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
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.
String marker
An opaque string that indicates the position at which to begin describing the VTL devices.
Integer limit
Specifies that the number of VTL devices described be limited to the specified number.
String gatewayARN
SdkInternalList<T> vTLDevices
An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
String marker
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.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
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.
Long workingStorageUsedInBytes
The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
Long workingStorageAllocatedInBytes
The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
String volumeARN
The Amazon Resource Name (ARN) of the volume to detach from the gateway.
Boolean forceDetach
Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The
default is false. If this value is set to false, you must manually disconnect the iSCSI
connection from the target volume.
Valid Values: true | false
String volumeARN
The Amazon Resource Name (ARN) of the volume that was detached.
String targetARN
Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
String networkInterfaceId
The network interface identifier of the VTL device.
Integer networkInterfacePort
The port used to communicate with iSCSI VTL device targets.
Boolean chapEnabled
Indicates whether mutual CHAP is enabled for the iSCSI target.
String gatewayARN
String gatewayARN
The unique Amazon Resource Name (ARN) of the disabled gateway.
String fileSystemAssociationARN
The Amazon Resource Name (ARN) of the file system association to be deleted.
Boolean forceDelete
If this value is set to true, the operation disassociates an Amazon FSx file system immediately. It ends all data
uploads to the file system, and the file system association enters the FORCE_DELETING status. If
this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.
String fileSystemAssociationARN
The Amazon Resource Name (ARN) of the deleted file system association.
String diskId
The unique device ID or other distinguishing data that identifies a local disk.
String diskPath
The path of a local disk in the gateway virtual machine (VM).
String diskNode
The device node of a local disk as assigned by the virtualization environment.
String diskStatus
A value that represents the status of a local disk.
Long diskSizeInBytes
The local disk size in bytes.
String diskAllocationType
String diskAllocationResource
The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.
SdkInternalList<T> diskAttributeList
SdkInternalList<T> ipAddresses
A list of gateway IP addresses on which the associated Amazon FSx file system is available.
If multiple file systems are associated with this gateway, this field is required.
String fileSystemAssociationARN
The Amazon Resource Name (ARN) of the file system association.
String locationARN
The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.
String fileSystemAssociationStatus
The status of the file system association. Valid Values: AVAILABLE | CREATING |
DELETING | FORCE_DELETING | UPDATING | ERROR
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for the audit logs.
String gatewayARN
SdkInternalList<T> tags
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.
CacheAttributes cacheAttributes
EndpointNetworkConfiguration endpointNetworkConfiguration
Specifies network configuration information for the gateway associated with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is
required.
SdkInternalList<T> fileSystemAssociationStatusDetails
An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.
String errorCode
The error code for a given file system association status.
String fileSystemAssociationId
The ID of the file system association.
String fileSystemAssociationARN
The Amazon Resource Name (ARN) of the file system association.
String fileSystemAssociationStatus
The status of the file share. Valid Values: AVAILABLE | CREATING |
DELETING | FORCE_DELETING | UPDATING | ERROR
String gatewayARN
String gatewayId
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.
String gatewayARN
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
String gatewayType
The type of the gateway.
String gatewayOperationalState
The state of the gateway.
Valid Values: DISABLED | ACTIVE
String gatewayName
The name of the gateway.
String ec2InstanceId
The ID of the Amazon EC2 instance that was used to launch the gateway.
String ec2InstanceRegion
The Amazon Web Services Region where the Amazon EC2 instance is located.
String gatewayARN
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of
gateways for your account and Amazon Web Services Region.
String domainName
The name of the domain that you want the gateway to join.
String organizationalUnit
The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
SdkInternalList<T> domainControllers
List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port
number include it after the colon (“:”). For example, mydc.mydomain.com:389.
Integer timeoutInSeconds
Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20
seconds.
String userName
Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
String password
Sets the password of the user who has permission to add the gateway to the Active Directory domain.
String gatewayARN
The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
String activeDirectoryStatus
Indicates the status of the gateway as a member of the Active Directory domain.
ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication
error.
DETACHED: Indicates that gateway is not joined to a domain.
JOINED: Indicates that the gateway has successfully joined a domain.
JOINING: Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or
connectivity error.
TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't
complete within the allotted time.
UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of
error.
String gatewayARN
SdkInternalList<T> automaticTapeCreationPolicyInfos
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.
String gatewayARN
The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
Integer limit
The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.
String marker
Opaque pagination token returned from a previous ListFileShares operation. If present, Marker
specifies where to continue the list from after a previous call to ListFileShares. Optional.
String marker
If the request includes Marker, the response returns that value in this field.
String nextMarker
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.
SdkInternalList<T> fileShareInfoList
An array of information about the S3 File Gateway's file shares.
String gatewayARN
Integer limit
The maximum number of file system associations to return in the response. If present, Limit must be
an integer with a value greater than zero. Optional.
String marker
Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present,
Marker specifies where to continue the list from after a previous call to
ListFileSystemAssociations. Optional.
String marker
If the request includes Marker, the response returns that value in this field.
String nextMarker
If a value is present, there are more file system associations to return. In a subsequent request, use
NextMarker as the value for Marker to retrieve the next set of file system
associations.
SdkInternalList<T> fileSystemAssociationSummaryList
An array of information about the Amazon FSx gateway's file system associations.
SdkInternalList<T> gateways
An array of GatewayInfo objects.
String marker
Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.
String gatewayARN
String gatewayARN
SdkInternalList<T> disks
A JSON object containing the following fields:
String resourceARN
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
String marker
An opaque string that indicates the position at which to begin returning the list of tags.
Integer limit
Specifies that the list of tags returned be limited to the specified number of items.
String resourceARN
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
String marker
An opaque string that indicates the position at which to stop returning the list of tags.
SdkInternalList<T> tags
An array that contains the tags for the specified resource.
SdkInternalList<T> poolARNs
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 marker
A string that indicates the position at which to begin the returned list of tape pools.
Integer limit
An optional number limit for the tape pools in the list returned by this call.
SdkInternalList<T> poolInfos
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.
String marker
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.
SdkInternalList<T> tapeARNs
String marker
A string that indicates the position at which to begin the returned list of tapes.
Integer limit
An optional number limit for the tapes in the list returned by this call.
SdkInternalList<T> tapeInfos
String marker
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.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
SdkInternalList<T> initiators
The host names and port numbers of all iSCSI initiators that are connected to the gateway.
String gatewayARN
String gatewayARN
SdkInternalList<T> volumeRecoveryPointInfos
An array of VolumeRecoveryPointInfo objects.
String gatewayARN
String marker
A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
Integer limit
Specifies that the list of volumes returned be limited to the specified number of items.
String gatewayARN
String marker
Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
SdkInternalList<T> volumeInfos
An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for
the gateway, then VolumeInfos is an empty array "[]".
String ipv4Address
The Internet Protocol version 4 (IPv4) address of the interface.
String macAddress
The Media Access Control (MAC) address of the interface.
This is currently unsupported and will not be returned in output.
String ipv6Address
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
String fileMode
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.
String directoryMode
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.
Long groupId
The default group ID for the file share (unless the files have another group ID specified). The default value is
nfsnobody.
Long ownerId
The default owner ID for files in the file share (unless the files have another owner ID specified). The default
value is nfsnobody.
NFSFileShareDefaults nFSFileShareDefaults
String fileShareARN
String fileShareId
String fileShareStatus
String gatewayARN
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
String path
String role
String locationARN
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
SdkInternalList<T> clientList
String squash
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set the write status
to read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
SdkInternalList<T> tags
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
String vPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String bucketRegion
Specifies the Region of the S3 bucket where the NFS file share stores files.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String fileShareARN
String poolARN
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 Amazon Web Services Region.
String poolName
The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.
String storageClass
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.
String retentionLockType
Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services 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 Amazon Web Services account.
Integer retentionLockTimeInDays
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
String poolStatus
Status of the custom tape pool. Pool can be ACTIVE or DELETED.
String fileShareARN
The Amazon Resource Name (ARN) of the file share you want to refresh.
SdkInternalList<T> folderList
A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The
default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to
true, the entire S3 bucket that the file share has access to is refreshed.
Boolean recursive
A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that
were in the cache the last time the gateway listed the folder's contents. If this value set to true,
each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in
FolderList are not refreshed. Only objects that are in folders listed directly under
FolderList are found and used for the update. The default is true.
Valid Values: true | false
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
SdkInternalList<T> tagKeys
The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.
String resourceARN
The Amazon Resource Name (ARN) of the resource that the tags were removed from.
String gatewayARN
String gatewayARN
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
String gatewayARN
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 Amazon Web Services Region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
String tapeARN
The Amazon Resource Name (ARN) of the retrieved virtual tape.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
StorageGatewayError error
A StorageGatewayError that provides more information about the cause of the error.
String gatewayARN
String gatewayARN
String gatewayARN
String gatewayARN
String fileShareARN
String fileShareId
String fileShareStatus
String gatewayARN
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
String path
The file share path used by the SMB client to identify the mount point.
String role
String locationARN
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set the write status
to read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Boolean sMBACLEnabled
If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file
share. If it is set to false, it indicates that file and directory permissions are mapped to the
POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Boolean accessBasedEnumeration
Indicates whether AccessBasedEnumeration is enabled.
SdkInternalList<T> adminUserList
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
SdkInternalList<T> 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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
SdkInternalList<T> 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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String authentication
String caseSensitivity
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the
case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value
is ClientSpecified.
SdkInternalList<T> tags
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource API operation.
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
String vPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
String bucketRegion
Specifies the Region of the S3 bucket where the SMB file share stores files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Boolean oplocksEnabled
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
SdkInternalList<T> gatewayAdmins
A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats
include: DOMAIN\User1, user1, DOMAIN\group1, and group1.
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
String gatewayARN
String gatewayARN
String gatewayARN
String gatewayARN
String volumeARN
The Amazon Resource Name (ARN) of the storage volume.
String volumeId
The unique identifier of the volume, e.g., vol-AE4B946D.
String volumeType
One of the VolumeType enumeration values describing the type of the volume.
String volumeStatus
One of the VolumeStatus values that indicates the state of the storage volume.
String volumeAttachmentStatus
A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.
Long volumeSizeInBytes
The size of the volume in bytes.
Double volumeProgress
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.
String volumeDiskId
The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
String sourceSnapshotId
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.
Boolean preservedExistingData
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true | false
VolumeiSCSIAttributes volumeiSCSIAttributes
An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
Date createdDate
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
Long volumeUsedInBytes
The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that
are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns
but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size
of the volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
String kMSKey
String targetName
The name of the iSCSI target used by an initiator to connect to a volume and used 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 on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape.
String tapeBarcode
The barcode that identifies a specific virtual tape.
Date tapeCreatedDate
The date the virtual tape was created.
Long tapeSizeInBytes
The size, in bytes, of the virtual tape capacity.
String tapeStatus
The current state of the virtual tape.
String vTLDevice
The virtual tape library (VTL) device that the virtual tape is associated with.
Double progress
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
Long tapeUsedInBytes
The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
String kMSKey
String poolId
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
Boolean worm
If the tape is archived as write-once-read-many (WORM), this value is true.
Date retentionStartDate
The date that the tape is first archived with tape retention lock enabled.
Date poolEntryDate
The date that the tape enters a custom tape pool.
String tapeARN
The Amazon Resource Name (ARN) of an archived virtual tape.
String tapeBarcode
The barcode that identifies the archived virtual tape.
Date tapeCreatedDate
The date the virtual tape was created.
Long tapeSizeInBytes
The size, in bytes, of the archived virtual tape.
Date completionTime
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.
String retrievedTo
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).
String tapeStatus
The current state of the archived virtual tape.
Long tapeUsedInBytes
The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
String kMSKey
String poolId
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
Boolean worm
Set to true if the archived tape is stored as write-once-read-many (WORM).
Date retentionStartDate
If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
Date poolEntryDate
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.
String tapeARN
The Amazon Resource Name (ARN) of a virtual tape.
String tapeBarcode
The barcode that identifies a specific virtual tape.
Long tapeSizeInBytes
The size, in bytes, of a virtual tape.
String tapeStatus
The status of the tape.
String gatewayARN
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
String poolId
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
Date retentionStartDate
The date that the tape became subject to tape retention lock.
Date poolEntryDate
The date that the tape entered the custom tape pool with tape retention lock enabled.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape.
Date tapeRecoveryPointTime
The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
Long tapeSizeInBytes
The size, in bytes, of the virtual tapes to recover.
String tapeStatus
The status of the virtual tapes.
SdkInternalList<T> automaticTapeCreationRules
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.
String gatewayARN
String gatewayARN
String gatewayARN
Long averageUploadRateLimitInBitsPerSec
The average upload bandwidth rate limit in bits per second.
Long averageDownloadRateLimitInBitsPerSec
The average download bandwidth rate limit in bits per second.
String gatewayARN
String gatewayARN
SdkInternalList<T> bandwidthRateLimitIntervals
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
String gatewayARN
String targetARN
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
String secretToAuthenticateInitiator
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
String initiatorName
The iSCSI initiator that connects to the target.
String secretToAuthenticateTarget
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.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
String fileSystemAssociationARN
The Amazon Resource Name (ARN) of the file system association that you want to update.
String userName
The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
String password
The password of the user credential.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for the audit logs.
CacheAttributes cacheAttributes
String fileSystemAssociationARN
The ARN of the updated file system association.
String gatewayARN
String gatewayName
String gatewayTimezone
A value that indicates the time zone of the gateway.
String cloudWatchLogGroupARN
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.
For more information, see What is Amazon CloudWatch Logs?
String gatewayCapacity
Specifies the size of the gateway's metadata cache.
String gatewayARN
String gatewayARN
String gatewayARN
Integer hourOfDay
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.
Integer minuteOfHour
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.
Integer dayOfWeek
The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
Integer dayOfMonth
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
String gatewayARN
String fileShareARN
The Amazon Resource Name (ARN) of the file share to be updated.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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.
NFSFileShareDefaults nFSFileShareDefaults
The default values for the file share. Optional.
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into. The default value is private.
SdkInternalList<T> clientList
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
String squash
The user mapped to anonymous user.
Valid values 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.
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set the write status
to read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Specifies refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String fileShareARN
The Amazon Resource Name (ARN) of the updated file share.
String fileShareARN
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
Boolean kMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to
use a key managed by Amazon S3. Optional.
Valid Values: true | false
String kMSKey
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 defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
String objectACL
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into. The default value is private.
Boolean readOnly
A value that sets the write status of a file share. Set this value to true to set write status to
read-only, otherwise set to false.
Valid Values: true | false
Boolean 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, otherwise set to false. The default value is
true.
Valid Values: true | false
Boolean requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays.
However, the S3 bucket owner always pays the cost of storing data.
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the
configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Boolean sMBACLEnabled
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to
false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
Boolean accessBasedEnumeration
The files and folders on this share will only be visible to users with read access.
SdkInternalList<T> adminUserList
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
SdkInternalList<T> 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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
SdkInternalList<T> 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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
String auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
String caseSensitivity
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the
case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value
is ClientSpecified.
String fileShareName
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access
point or access point alias is used.
CacheAttributes cacheAttributes
Specifies refresh cache information for the file share.
String notificationPolicy
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to
wait after the last point in time a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as
possible to avoid generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
Boolean oplocksEnabled
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
String fileShareARN
The Amazon Resource Name (ARN) of the updated SMB file share.
String gatewayARN
String gatewayARN
SMBLocalGroups sMBLocalGroups
A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.
String gatewayARN
String gatewayARN
String sMBSecurityStrategy
Specifies the type of security strategy.
ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only in S3 File Gateway.
MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
String gatewayARN
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
Integer startAt
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.
Integer recurrenceInHours
Frequency of snapshots. Specify the number of hours between snapshots.
String description
Optional description of the snapshot that overwrites the existing description.
SdkInternalList<T> tags
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
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.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
String vTLDeviceARN
The Amazon Resource Name (ARN) of the medium changer you have selected.
String volumeARN
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 (-).
String volumeId
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 (-).
String gatewayARN
String gatewayId
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 (-).
String volumeType
One of the VolumeType enumeration values describing the type of the volume.
Long volumeSizeInBytes
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
String volumeAttachmentStatus
One of the VolumeStatus values that indicates the state of the storage volume.
String targetARN
The Amazon Resource Name (ARN) of the volume target.
String networkInterfaceId
The network interface identifier.
Integer networkInterfacePort
The port used to communicate with iSCSI targets.
Integer lunNumber
The logical disk number.
Boolean chapEnabled
Indicates whether mutual CHAP is enabled for the iSCSI target.
String volumeARN
The Amazon Resource Name (ARN) of the volume target.
Long volumeSizeInBytes
The size of the volume in bytes.
Long volumeUsageInBytes
The size of the data stored on the volume in bytes.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
String volumeRecoveryPointTime
The time the recovery point was taken.
String vTLDeviceARN
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
String vTLDeviceType
Specifies the type of device that the VTL device emulates.
String vTLDeviceVendor
Specifies the vendor of the device that the VTL device object emulates.
String vTLDeviceProductIdentifier
Specifies the model number of device that the VTL device emulates.
DeviceiSCSIAttributes deviceiSCSIAttributes
A list of iSCSI information about a VTL device.
Copyright © 2021. All rights reserved.