ListGatewayGroups
Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
Request Syntax
{
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of gateway group summaries to return. The default is 50.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token used to paginate though multiple pages of gateway group summaries.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
Required: No
Response Syntax
{
"GatewayGroups": [
{
"Arn": "string",
"Description": "string",
"Name": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- GatewayGroups
-
The gateway groups in the list.
Type: Array of GatewayGroupSummary objects
- NextToken
-
The token used to paginate though multiple pages of gateway group summaries.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
