StorageGateway / Client / delete_chap_credentials

delete_chap_credentials¶

StorageGateway.Client.delete_chap_credentials(**kwargs)¶

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.

Request Syntax

response = client.delete_chap_credentials(
    TargetARN='string',
    InitiatorName='string'
)

Parameters:

TargetARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
InitiatorName (string) –
[REQUIRED]

The iSCSI initiator that connects to the target.

Return type:

dict

Returns:

Response Syntax

{
    'TargetARN': 'string',
    'InitiatorName': 'string'
}

Response Structure

(dict) –

A JSON object containing the following fields:
- TargetARN (string) –
  
  The Amazon Resource Name (ARN) of the target.
- InitiatorName (string) –
  
  The iSCSI initiator that connects to the target.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError

Examples

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

response = client.delete_chap_credentials(
    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',
)

print(response)

Expected Output:

{
    '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',
    'ResponseMetadata': {
        '...': '...',
    },
}