Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

post/#X-Amz-Target=StorageGateway_20130630.UpdateChapCredentials

Headers

X-Amz-Target'StorageGateway_20130630.UpdateChapCredentials' required

Request body

TargetARNstring required

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN.

SecretToAuthenticateInitiatorstring password required
<p>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</p> <note> <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p> </note>
InitiatorNamestring required

The iSCSI initiator that connects to the target.

SecretToAuthenticateTargetstring password
<p>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</p> <p>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</p> <note> <p>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</p> </note>

Response

Success

TargetARNstring

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

InitiatorNamestring

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

Example response

{
  "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
  "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
}