StorageGateway / Client / update_gateway_information

update_gateway_information#

StorageGateway.Client.update_gateway_information(**kwargs)#

Updates a gateway’s metadata, which includes the gateway’s name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Note

For gateways activated after September 2, 2015, the gateway’s ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway’s ARN.

See also: AWS API Documentation

Request Syntax

response = client.update_gateway_information(
    GatewayARN='string',
    GatewayName='string',
    GatewayTimezone='string',
    CloudWatchLogGroupARN='string',
    GatewayCapacity='Small'|'Medium'|'Large'
)
Parameters:

  • GatewayARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • GatewayName (string) – The name you configured for your gateway.

  • GatewayTimezone (string) – A value that indicates the time zone of the gateway.

  • CloudWatchLogGroupARN (string) –

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

    For more information, see What is Amazon CloudWatch Logs?

  • GatewayCapacity (string) – Specifies the size of the gateway’s metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'GatewayName': 'string'
}

Response Structure

  • (dict) –

    A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

    • GatewayARN (string) –

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    • GatewayName (string) –

      The name you configured for your gateway.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Updates a gateway’s metadata, which includes the gateway’s name and time zone.

response = client.update_gateway_information(
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    GatewayName='MyGateway2',
    GatewayTimezone='GMT-12:00',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'GatewayName': '',
    'ResponseMetadata': {
        '...': '...',
    },
}