BackupGateway

Client

class BackupGateway.Client

A low-level client representing AWS Backup Gateway

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways , then choose Create gateway .

client = session.create_client('backup-gateway')

These are the available methods:

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

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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 key part of a value'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

delete_gateway(**kwargs)

Deletes a backup gateway.

See also: AWS API Documentation

Request Syntax

response = client.delete_gateway(
    GatewayArn='string'
)
Parameters
GatewayArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway to delete.

Return type
dict
Returns
Response Syntax
{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --
    • GatewayArn (string) --

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

Exceptions

delete_hypervisor(**kwargs)

Deletes a hypervisor.

See also: AWS API Documentation

Request Syntax

response = client.delete_hypervisor(
    HypervisorArn='string'
)
Parameters
HypervisorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor to delete.

Return type
dict
Returns
Response Syntax
{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --
    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor you deleted.

Exceptions

disassociate_gateway_from_server(**kwargs)

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_gateway_from_server(
    GatewayArn='string'
)
Parameters
GatewayArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway to disassociate.

Return type
dict
Returns
Response Syntax
{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --
    • GatewayArn (string) --

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

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
import_hypervisor_configuration(**kwargs)

Connect to a hypervisor by importing its configuration.

See also: AWS API Documentation

Request Syntax

response = client.import_hypervisor_configuration(
    Host='string',
    KmsKeyArn='string',
    Name='string',
    Password='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Username='string'
)
Parameters
  • Host (string) --

    [REQUIRED]

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • KmsKeyArn (string) -- The Key Management Service for the hypervisor.
  • Name (string) --

    [REQUIRED]

    The name of the hypervisor.

  • Password (string) -- The password for the hypervisor.
  • Tags (list) --

    The tags of the hypervisor configuration to import.

    • (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 key part of a value's key-value pair.

  • Username (string) -- The username for the hypervisor.
Return type

dict

Returns

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor you disassociated.

Exceptions

list_gateways(**kwargs)

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.list_gateways(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of gateways to list.
  • NextToken (string) -- The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Return type

dict

Returns

Response Syntax

{
    'Gateways': [
        {
            'GatewayArn': 'string',
            'GatewayDisplayName': 'string',
            'GatewayType': 'BACKUP_VM',
            'HypervisorId': 'string',
            'LastSeenTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Gateways (list) --

      A list of your gateways.

      • (dict) --

        A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

        • GatewayArn (string) --

          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.

        • GatewayDisplayName (string) --

          The display name of the gateway.

        • GatewayType (string) --

          The type of the gateway.

        • HypervisorId (string) --

          The hypervisor ID of the gateway.

        • LastSeenTime (datetime) --

          The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

list_hypervisors(**kwargs)

Lists your hypervisors.

See also: AWS API Documentation

Request Syntax

response = client.list_hypervisors(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of hypervisors to list.
  • NextToken (string) -- The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Return type

dict

Returns

Response Syntax

{
    'Hypervisors': [
        {
            'Host': 'string',
            'HypervisorArn': 'string',
            'KmsKeyArn': 'string',
            'Name': 'string',
            'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Hypervisors (list) --

      A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

      • (dict) --

        Represents the hypervisor's permissions to which the gateway will connect.

        A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

        • Host (string) --

          The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

        • HypervisorArn (string) --

          The Amazon Resource Name (ARN) of the hypervisor.

        • KmsKeyArn (string) --

          The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

        • Name (string) --

          The name of the hypervisor.

        • State (string) --

          The state of the hypervisor.

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource's tags to list.

Return type
dict
Returns
Response Syntax
{
    'ResourceArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ResourceArn (string) --

      The Amazon Resource Name (ARN) of the resource's tags that you listed.

    • Tags (list) --

      A list of the resource's tags.

      • (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) --

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

        • Value (string) --

          The key part of a value's key-value pair.

Exceptions

list_virtual_machines(**kwargs)

Lists your virtual machines.

See also: AWS API Documentation

Request Syntax

response = client.list_virtual_machines(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of virtual machines to list.
  • NextToken (string) -- The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'VirtualMachines': [
        {
            'HostName': 'string',
            'HypervisorId': 'string',
            'LastBackupDate': datetime(2015, 1, 1),
            'Name': 'string',
            'Path': 'string',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • VirtualMachines (list) --

      A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

      • (dict) --

        A virtual machine that is on a hypervisor.

        • HostName (string) --

          The host name of the virtual machine.

        • HypervisorId (string) --

          The ID of the virtual machine's hypervisor.

        • LastBackupDate (datetime) --

          The most recent date a virtual machine was backed up, in Unix format and UTC time.

        • Name (string) --

          The name of the virtual machine.

        • Path (string) --

          The path of the virtual machine.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the virtual machine.

Exceptions

put_maintenance_start_time(**kwargs)

Set the maintenance start time for a gateway.

See also: AWS API Documentation

Request Syntax

response = client.put_maintenance_start_time(
    DayOfMonth=123,
    DayOfWeek=123,
    GatewayArn='string',
    HourOfDay=123,
    MinuteOfHour=123
)
Parameters
  • DayOfMonth (integer) --

    The day of the month start maintenance on a gateway.

    Valid values range from Sunday to Saturday .

  • DayOfWeek (integer) -- The day of the week to start maintenance on a gateway.
  • GatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.

  • HourOfDay (integer) --

    [REQUIRED]

    The hour of the day to start maintenance on a gateway.

  • MinuteOfHour (integer) --

    [REQUIRED]

    The minute of the hour to start maintenance on a gateway.

Return type

dict

Returns

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --

    • GatewayArn (string) --

      The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.

Exceptions

tag_resource(**kwargs)

Tag the resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to tag.

  • Tags (list) --

    [REQUIRED]

    A list of tags to assign to the resource.

    • (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 key part of a value's key-value pair.

Return type

dict

Returns

Response Syntax

{
    'ResourceARN': 'string'
}

Response Structure

  • (dict) --

    • ResourceARN (string) --

      The Amazon Resource Name (ARN) of the resource you tagged.

Exceptions

test_hypervisor_configuration(**kwargs)

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

See also: AWS API Documentation

Request Syntax

response = client.test_hypervisor_configuration(
    GatewayArn='string',
    Host='string',
    Password='string',
    Username='string'
)
Parameters
  • GatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.

  • Host (string) --

    [REQUIRED]

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • Password (string) -- The password for the hypervisor.
  • Username (string) -- The username for the hypervisor.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from the resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

  • TagKeys (list) --

    [REQUIRED]

    The list of tag keys specifying which tags to remove.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'ResourceARN': 'string'
}

Response Structure

  • (dict) --

    • ResourceARN (string) --

      The Amazon Resource Name (ARN) of the resource from which you removed tags.

Exceptions

update_gateway_information(**kwargs)

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

See also: AWS API Documentation

Request Syntax

response = client.update_gateway_information(
    GatewayArn='string',
    GatewayDisplayName='string'
)
Parameters
  • GatewayArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway to update.

  • GatewayDisplayName (string) -- The updated display name of the gateway.
Return type

dict

Returns

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --

    • GatewayArn (string) --

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

Exceptions

update_hypervisor(**kwargs)

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

See also: AWS API Documentation

Request Syntax

response = client.update_hypervisor(
    Host='string',
    HypervisorArn='string',
    Password='string',
    Username='string'
)
Parameters
  • Host (string) -- The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
  • HypervisorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the hypervisor to update.

  • Password (string) -- The updated password for the hypervisor.
  • Username (string) -- The updated username for the hypervisor.
Return type

dict

Returns

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor you updated.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class BackupGateway.Client.exceptions.AccessDeniedException

The operation cannot proceed because you have insufficient permissions.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'ErrorCode': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation cannot proceed because you have insufficient permissions.

    • ErrorCode (string) --

      A description of why you have insufficient permissions.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BackupGateway.Client.exceptions.ConflictException

The operation cannot proceed because it is not supported.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'ErrorCode': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation cannot proceed because it is not supported.

    • ErrorCode (string) --

      A description of why the operation is not supported.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BackupGateway.Client.exceptions.InternalServerException

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

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'ErrorCode': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

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

    • ErrorCode (string) --

      A description of which internal error occured.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BackupGateway.Client.exceptions.ResourceNotFoundException

A resource that is required for the action wasn't found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'ErrorCode': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource that is required for the action wasn't found.

    • ErrorCode (string) --

      A description of which resource wasn't found.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class BackupGateway.Client.exceptions.ValidationException

The operation did not succeed because a validation error occurred.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'ErrorCode': 'string',
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation did not succeed because a validation error occurred.

    • ErrorCode (string) --

      A description of what caused the validation error.

    • Message (string) --

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class BackupGateway.Paginator.ListGateways
paginator = client.get_paginator('list_gateways')
paginate(**kwargs)

Creates an iterator that will paginate through responses from BackupGateway.Client.list_gateways().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Gateways': [
        {
            'GatewayArn': 'string',
            'GatewayDisplayName': 'string',
            'GatewayType': 'BACKUP_VM',
            'HypervisorId': 'string',
            'LastSeenTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --
    • Gateways (list) --

      A list of your gateways.

      • (dict) --

        A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

        • GatewayArn (string) --

          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.

        • GatewayDisplayName (string) --

          The display name of the gateway.

        • GatewayType (string) --

          The type of the gateway.

        • HypervisorId (string) --

          The hypervisor ID of the gateway.

        • LastSeenTime (datetime) --

          The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

class BackupGateway.Paginator.ListHypervisors
paginator = client.get_paginator('list_hypervisors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from BackupGateway.Client.list_hypervisors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Hypervisors': [
        {
            'Host': 'string',
            'HypervisorArn': 'string',
            'KmsKeyArn': 'string',
            'Name': 'string',
            'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
        },
    ],

}

Response Structure

  • (dict) --
    • Hypervisors (list) --

      A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

      • (dict) --

        Represents the hypervisor's permissions to which the gateway will connect.

        A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

        • Host (string) --

          The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

        • HypervisorArn (string) --

          The Amazon Resource Name (ARN) of the hypervisor.

        • KmsKeyArn (string) --

          The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

        • Name (string) --

          The name of the hypervisor.

        • State (string) --

          The state of the hypervisor.

class BackupGateway.Paginator.ListVirtualMachines
paginator = client.get_paginator('list_virtual_machines')
paginate(**kwargs)

Creates an iterator that will paginate through responses from BackupGateway.Client.list_virtual_machines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'VirtualMachines': [
        {
            'HostName': 'string',
            'HypervisorId': 'string',
            'LastBackupDate': datetime(2015, 1, 1),
            'Name': 'string',
            'Path': 'string',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • VirtualMachines (list) --

      A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

      • (dict) --

        A virtual machine that is on a hypervisor.

        • HostName (string) --

          The host name of the virtual machine.

        • HypervisorId (string) --

          The ID of the virtual machine's hypervisor.

        • LastBackupDate (datetime) --

          The most recent date a virtual machine was backed up, in Unix format and UTC time.

        • Name (string) --

          The name of the virtual machine.

        • Path (string) --

          The path of the virtual machine.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the virtual machine.