associate_gateway_to_server

BackupGateway.Client.associate_gateway_to_server(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.associate_gateway_to_server(
    GatewayArn='string',
    ServerArn='string'
)
Parameters
  • GatewayArn (string) --

    [REQUIRED]

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

  • ServerArn (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --

    • GatewayArn (string) --

      The Amazon Resource Name (ARN) of a gateway.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException
  • BackupGateway.Client.exceptions.ConflictException
  • BackupGateway.Client.exceptions.InternalServerException
  • BackupGateway.Client.exceptions.ThrottlingException