BackupGateway / Client / update_gateway_information

update_gateway_information#

BackupGateway.Client.update_gateway_information(**kwargs)#

Updates a gateway’s name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

response = client.update_gateway_information(
    GatewayArn='string',
    GatewayDisplayName='string'
)

Parameters:

GatewayArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the gateway to update.
GatewayDisplayName (string) – The updated display name of the gateway.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

(dict) –
- GatewayArn (string) –
  
  The Amazon Resource Name (ARN) of the gateway you updated.

Exceptions