AlexaForBusiness / Client / update_gateway

update_gateway#

AlexaForBusiness.Client.update_gateway(**kwargs)#

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.update_gateway(
    GatewayArn='string',
    Name='string',
    Description='string',
    SoftwareVersion='string'
)
Parameters:

  • GatewayArn (string) –

    [REQUIRED]

    The ARN of the gateway to update.

  • Name (string) – The updated name of the gateway.

  • Description (string) – The updated description of the gateway.

  • SoftwareVersion (string) – The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException

  • AlexaForBusiness.Client.exceptions.NameInUseException