list_gateway_groups

list_gateway_groups(**kwargs)

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

See also: AWS API Documentation

Request Syntax

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

Parameters

• NextToken (string) -- The token used to paginate though multiple pages of gateway group summaries.
• MaxResults (integer) -- The maximum number of gateway group summaries to return. The default is 50.

Return type

dict

Returns

Response Syntax

{
    'GatewayGroups': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • GatewayGroups (list) --

    The gateway groups in the list.

    • (dict) --

      The summary of a gateway group.

      • Arn (string) --

        The ARN of the gateway group.

      • Name (string) --

        The name of the gateway group.

      • Description (string) --

        The description of the gateway group.

  • NextToken (string) --

    The token used to paginate though multiple pages of gateway group summaries.