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 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 the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "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.
String tapeDriveType
The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.
Valid Values: "IBM-ULT3580-TD5"
String mediumChangerType
The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.
Valid Values: "STK-L700", "AWS-Gateway-VTL"
String gatewayARN
String gatewayARN
com.amazonaws.internal.SdkInternalList<T> diskIds
String gatewayARN
String resourceARN
The Amazon Resource Name (ARN) of the resource you want to add tags to.
com.amazonaws.internal.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
com.amazonaws.internal.SdkInternalList<T> diskIds
String gatewayARN
String gatewayARN
com.amazonaws.internal.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 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 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.
com.amazonaws.internal.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 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.
com.amazonaws.internal.SdkInternalList<T> volumeARNs
com.amazonaws.internal.SdkInternalList<T> cachediSCSIVolumes
An array of objects where each object contains metadata about one cached volume.
String gatewayARN
String gatewayARN
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.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 volumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> storediSCSIVolumes
com.amazonaws.internal.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.
com.amazonaws.internal.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
com.amazonaws.internal.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
com.amazonaws.internal.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, AWS Storage 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.
com.amazonaws.internal.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
com.amazonaws.internal.SdkInternalList<T> diskIds
Long uploadBufferUsedInBytes
Long uploadBufferAllocatedInBytes
String gatewayARN
com.amazonaws.internal.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
com.amazonaws.internal.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
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> gateways
String marker
String gatewayARN
String gatewayARN
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> tags
An array that contains the tags for the specified resource.
com.amazonaws.internal.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.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> initiators
The host names and port numbers of all iSCSI initiators that are connected to the gateway.
String gatewayARN
String gatewayARN
com.amazonaws.internal.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
com.amazonaws.internal.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 resourceARN
The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
com.amazonaws.internal.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 gateway-VTL.
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.
String gatewayARN
String gatewayARN
String gatewayARN
String gatewayARN
String gatewayARN
String volumeARN
String volumeId
String volumeType
String volumeStatus
Long volumeSizeInBytes
Double volumeProgress
String volumeDiskId
String sourceSnapshotId
Boolean preservedExistingData
VolumeiSCSIAttributes volumeiSCSIAttributes
String tapeARN
The Amazon Resource Name (ARN) of the virtual tape.
String tapeBarcode
The barcode that identifies a specific virtual tape.
Long tapeSizeInBytes
The size, in bytes, of the virtual tape.
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).
String tapeARN
The Amazon Resource Name (ARN) of an archived virtual tape.
String tapeBarcode
The barcode that identifies the archived virtual tape.
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 gateway-VTL 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.
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.
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.
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, in bytes, of the volume.
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 © 2016. All rights reserved.