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.
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 region where you want to store your data. The gateway region specified must be the
same region as the region in your Host header in the request. For more information about available
regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
Amazon Web Services Glossary.
Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"
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 STORED.
Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
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"
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
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: + - = . _ : / @.
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
String gatewayARN
SdkInternalList<T> diskIds
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
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 that describes the type of the volume.
String volumeStatus
One of the VolumeStatus values that indicates the state of the storage volume.
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 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 time stamp.
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
String snapshotId
String targetName
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
String clientToken
String clientToken
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
NFSFileShareDefaults nFSFileShareDefaults
File share default values. Optional.
String gatewayARN
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
Boolean kMSEncrypted
True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
String kMSKey
The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.
String role
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
String locationARN
The ARN of the backed storage used for storing file data.
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
SdkInternalList<T> clientList
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
String squash
Maps a user to anonymous user. Valid options are the following:
"RootSquash" - Only root is mapped to anonymous user.
"NoSquash" - No one is mapped to anonymous user.
"AllSquash" - Everyone is mapped to anonymous user.
Boolean readOnly
Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
String fileShareARN
The Amazon Resource Name (ARN) of the newly created file share.
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 AWS Storage Gateway snapshot Details pane, Description field
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
Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values: true, false
String targetName
The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For
example, specifying TargetName as myvolume results in the target ARN of
arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The
target name must be unique across all volumes of a 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 volumeARN
The Amazon Resource Name (ARN) of the configured volume.
Long volumeSizeInBytes
The size of the volume in bytes.
String targetARN
he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
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 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 byte).
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 to 4 characters in length and must be one of the uppercase letters from A to Z.
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 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 byte).
String tapeBarcode
The barcode that you want to assign to the tape.
String tapeARN
A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
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.
String fileShareARN
The Amazon Resource Name (ARN) of the deleted file share.
String gatewayARN
String gatewayARN
String volumeARN
String volumeARN
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
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 region.
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape to delete.
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
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.
SdkInternalList<T> volumeARNs
SdkInternalList<T> cachediSCSIVolumes
An array of objects where each object contains metadata about one cached volume.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
Long cacheAllocatedInBytes
Double cacheUsedPercentage
Double cacheDirtyPercentage
Double cacheHitPercentage
Double cacheMissPercentage
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.
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 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.
String timezone
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.
String volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
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 from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
SdkInternalList<T> storediSCSIVolumes
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 descried 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 which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
String gatewayARN
String gatewayARN
SdkInternalList<T> diskIds
Long uploadBufferUsedInBytes
Long uploadBufferAllocatedInBytes
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 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 of the disabled gateway.
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 region.
String gatewayType
The type of the gateway.
String gatewayOperationalState
The state of the gateway.
Valid Values: DISABLED or ACTIVE
String gatewayName
The name of the gateway.
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 file gateway's file shares.
SdkInternalList<T> gateways
String marker
String gatewayARN
String gatewayARN
SdkInternalList<T> disks
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
he 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> 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
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
SdkInternalList<T> volumeInfos
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
True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
String kMSKey
String path
String role
String locationARN
String defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
SdkInternalList<T> clientList
String squash
Boolean readOnly
String fileShareARN
String fileShareARN
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 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 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.
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 time stamp.
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 written to the virtual tape.
This value is not available for tapes created prior to May,13 2015.
String tapeARN
The Amazon Resource Name (ARN) of an archived virtual tape.
String tapeBarcode
The barcode that identifies the archived virtual tape.
Date tapeCreatedDate
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 string format of the completion time 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 written to the virtual tape.
This value is not available for tapes created prior to May,13 2015.
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 region.
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 string 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
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 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 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 maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
String gatewayARN
String fileShareARN
The Amazon Resource Name (ARN) of the file share to be updated.
Boolean kMSEncrypted
True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
String kMSKey
The KMS key used for Amazon S3 server side encryption. 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 a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
SdkInternalList<T> clientList
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
String squash
The user mapped to anonymous user. Valid options are the following:
"RootSquash" - Only root is mapped to anonymous user.
"NoSquash" - No one is mapped to anonymous user
"AllSquash" - Everyone is mapped to anonymous user.
Boolean readOnly
Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
String fileShareARN
The Amazon Resource Name (ARN) of the updated file share.
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.
String volumeARN
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-1: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
Long volumeSizeInBytes
The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
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 vTLDeviceARN
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
String vTLDeviceType
String vTLDeviceVendor
String vTLDeviceProductIdentifier
DeviceiSCSIAttributes deviceiSCSIAttributes
A list of iSCSI information about a VTL device.
Copyright © 2017. All rights reserved.