Creates a backup gateway. After you create a gateway, you can associate it with a server
using the AssociateGatewayToServer operation.
Request Syntax
{
"ActivationKey": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"Tags": [
{
"Key": "string",
"Value": "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.
- ActivationKey
-
The activation key of the created gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
^[0-9a-zA-Z\-]+$Required: Yes
- GatewayDisplayName
-
The display name of the created gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-]*$Required: Yes
- GatewayType
-
The type of created gateway.
Type: String
Valid Values:
BACKUP_VMRequired: Yes
- Tags
-
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
Type: Array of Tag objects
Required: No
Response Syntax
{
"GatewayArn": "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.
- GatewayArn
-
The Amazon Resource Name (ARN) of the gateway you create.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$
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:
