AlexaForBusiness / Client / list_gateways

list_gateways#

AlexaForBusiness.Client.list_gateways(**kwargs)#

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

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.

Request Syntax

response = client.list_gateways(
    GatewayGroupArn='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

GatewayGroupArn (string) – The gateway group ARN for which to list gateways.
NextToken (string) – The token used to paginate though multiple pages of gateway summaries.
MaxResults (integer) – The maximum number of gateway summaries to return. The default is 50.

Return type:

dict

Returns:

Response Syntax

{
    'Gateways': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'GatewayGroupArn': 'string',
            'SoftwareVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Gateways (list) –
  
  The gateways in the list.
  - (dict) –
    
    The summary of a 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.
- NextToken (string) –
  
  The token used to paginate though multiple pages of gateway summaries.