[ aws . alexaforbusiness ]
list-gateway-groups¶
Description¶
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-gateway-groups
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--next-token (string)
The token used to paginate though multiple pages of gateway group summaries.
--max-results (integer)
The maximum number of gateway group summaries to return. The default is 50.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
GatewayGroups -> (list)
The gateway groups in the list.
(structure)
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.