BackupGateway / Client / create_gateway

create_gateway#

BackupGateway.Client.create_gateway(**kwargs)#

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

See also: AWS API Documentation

Request Syntax

response = client.create_gateway(
    ActivationKey='string',
    GatewayDisplayName='string',
    GatewayType='BACKUP_VM',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ActivationKey (string) –

    [REQUIRED]

    The activation key of the created gateway.

  • GatewayDisplayName (string) –

    [REQUIRED]

    The display name of the created gateway.

  • GatewayType (string) –

    [REQUIRED]

    The type of created gateway.

  • Tags (list) –

    A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

    • (dict) –

      A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

      • Key (string) – [REQUIRED]

        The key part of a tag’s key-value pair. The key can’t start with aws:.

      • Value (string) – [REQUIRED]

        The value part of a tag’s key-value pair.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) –

    • GatewayArn (string) –

      The Amazon Resource Name (ARN) of the gateway you create.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.ThrottlingException