Lists backup gateways owned by an AWS account in an AWS Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
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 gateways to list.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- NextToken
-
The next item following a partial list of returned resources. For example, if a request is made to return
MaxResultsnumber of resources,NextTokenallows you to return more items in your list starting at the location pointed to by the next token.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^.+$Required: No
Response Syntax
{
"Gateways": [
{
"GatewayArn": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"HypervisorId": "string",
"LastSeenTime": number
}
],
"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
-
A list of your gateways.
Type: Array of Gateway objects
- NextToken
-
The next item following a partial list of returned resources. For example, if a request is made to return
maxResultsnumber of resources,NextTokenallows you to return more items in your list starting at the location pointed to by the next token.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^.+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The operation did not succeed because an internal error occurred. Try again later.
HTTP Status Code: 500
- ThrottlingException
-
TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
- ValidationException
-
The operation did not succeed because a validation error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
