AttachVolume
Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
Request Syntax
{
"DiskId": "string
",
"GatewayARN": "string
",
"NetworkInterfaceId": "string
",
"TargetName": "string
",
"VolumeARN": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- GatewayARN
-
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
- 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.
Type: String
Pattern:
\A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
Required: Yes
- 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 ofarn: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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[-\.;a-z0-9]+$
Required: No
- VolumeARN
-
The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)
Required: Yes
Response Syntax
{
"TargetARN": "string",
"VolumeARN": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- TargetARN
-
The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 800.
- VolumeARN
-
The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
Examples
Example request
The following example shows a request that attaches a volume to a gateway.
Sample Request
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20181025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630. AttachVolume
{
"DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
"GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
"NetworkInterfaceId": "10.1.1.1",
"TargetName": "myvolume",
"VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Thu, 25 Oct 2018 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80
{
"TargetARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
"VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: