get_gateway#

AlexaForBusiness.Client.get_gateway(**kwargs)#

Retrieves the details of a gateway.

Request Syntax

response = client.get_gateway(
    GatewayArn='string'
)

Parameters:

GatewayArn (string) –

[REQUIRED]

The ARN of the gateway to get.

Return type:

dict

Returns:

Response Syntax

{
    'Gateway': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'GatewayGroupArn': 'string',
        'SoftwareVersion': 'string'
    }
}

Response Structure

(dict) –
- Gateway (dict) –
  
  The details of the gateway.
  - Arn (string) –
    
    The ARN of the gateway.
  - Name (string) –
    
    The name of the gateway.
  - Description (string) –
    
    The description of the gateway.
  - GatewayGroupArn (string) –
    
    The ARN of the gateway group that the gateway is associated to.
  - SoftwareVersion (string) –
    
    The software version of the gateway. The gateway automatically updates its software version during normal operation.

Exceptions

AlexaForBusiness.Client.exceptions.NotFoundException