AssociateGatewayToServer - AWS Backup

AssociateGatewayToServer

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Request Syntax

{ "GatewayArn": "string", "ServerArn": "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.

GatewayArn

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$

Required: Yes

ServerArn

The Amazon Resource Name (ARN) of the server that hosts your virtual machines.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$

Required: Yes

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 a gateway.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

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.

ConflictException

The operation cannot proceed because it is not supported.

HTTP Status Code: 400

InternalServerException

The operation did not succeed because an internal error occurred. Try again later.

HTTP Status Code: 500

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: