ListGateways
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.
Request Syntax
{
"GatewayGroupArn": "string",
"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.
- GatewayGroupArn
-
The gateway group ARN for which to list gateways.
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
- MaxResults
-
The maximum number of gateway 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 summaries.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1100.
Required: No
Response Syntax
{
"Gateways": [
{
"Arn": "string",
"Description": "string",
"GatewayGroupArn": "string",
"Name": "string",
"SoftwareVersion": "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.
- Gateways
-
The gateways in the list.
Type: Array of GatewaySummary objects
- NextToken
-
The token used to paginate though multiple pages of gateway 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:
