AWS Backup Gateway

2022/12/15 - AWS Backup Gateway - 6 new2 updated api methods

Changes  This release adds support for VMware vSphere tags, enabling customer to protect VMware virtual machines using tag-based policies for AWS tags mapped from vSphere tags. This release also adds support for customer-accessible gateway-hypervisor interaction log and upload bandwidth rate limit schedule.

PutBandwidthRateLimitSchedule (new) Link ¶

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

See also: AWS API Documentation

Request Syntax

client.put_bandwidth_rate_limit_schedule(
    BandwidthRateLimitIntervals=[
        {
            'AverageUploadRateLimitInBitsPerSec': 123,
            'DaysOfWeek': [
                123,
            ],
            'EndHourOfDay': 123,
            'EndMinuteOfHour': 123,
            'StartHourOfDay': 123,
            'StartMinuteOfHour': 123
        },
    ],
    GatewayArn='string'
)
type BandwidthRateLimitIntervals:

list

param BandwidthRateLimitIntervals:

[REQUIRED]

An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

  • (dict) --

    Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

    • AverageUploadRateLimitInBitsPerSec (integer) --

      The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

    • DaysOfWeek (list) -- [REQUIRED]

      The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

      • (integer) --

    • EndHourOfDay (integer) -- [REQUIRED]

      The hour of the day to end the bandwidth rate limit interval.

    • EndMinuteOfHour (integer) -- [REQUIRED]

      The minute of the hour to end the bandwidth rate limit interval.

    • StartHourOfDay (integer) -- [REQUIRED]

      The hour of the day to start the bandwidth rate limit interval.

    • StartMinuteOfHour (integer) -- [REQUIRED]

      The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

type GatewayArn:

string

param GatewayArn:

[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.

rtype:

dict

returns:

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --

    • 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.

PutHypervisorPropertyMappings (new) Link ¶

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

See also: AWS API Documentation

Request Syntax

client.put_hypervisor_property_mappings(
    HypervisorArn='string',
    IamRoleArn='string',
    VmwareToAwsTagMappings=[
        {
            'AwsTagKey': 'string',
            'AwsTagValue': 'string',
            'VmwareCategory': 'string',
            'VmwareTagName': 'string'
        },
    ]
)
type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

type IamRoleArn:

string

param IamRoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role.

type VmwareToAwsTagMappings:

list

param VmwareToAwsTagMappings:

[REQUIRED]

This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.

  • (dict) --

    This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

    • AwsTagKey (string) -- [REQUIRED]

      The key part of the Amazon Web Services tag's key-value pair.

    • AwsTagValue (string) -- [REQUIRED]

      The value part of the Amazon Web Services tag's key-value pair.

    • VmwareCategory (string) -- [REQUIRED]

      The is the category of VMware.

    • VmwareTagName (string) -- [REQUIRED]

      This is the user-defined name of a VMware tag.

rtype:

dict

returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor.

GetHypervisorPropertyMappings (new) Link ¶

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

See also: AWS API Documentation

Request Syntax

client.get_hypervisor_property_mappings(
    HypervisorArn='string'
)
type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

rtype:

dict

returns:

Response Syntax

{
    'HypervisorArn': 'string',
    'IamRoleArn': 'string',
    'VmwareToAwsTagMappings': [
        {
            'AwsTagKey': 'string',
            'AwsTagValue': 'string',
            'VmwareCategory': 'string',
            'VmwareTagName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor.

    • IamRoleArn (string) --

      The Amazon Resource Name (ARN) of the IAM role.

    • VmwareToAwsTagMappings (list) --

      This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.

      • (dict) --

        This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

        • AwsTagKey (string) --

          The key part of the Amazon Web Services tag's key-value pair.

        • AwsTagValue (string) --

          The value part of the Amazon Web Services tag's key-value pair.

        • VmwareCategory (string) --

          The is the category of VMware.

        • VmwareTagName (string) --

          This is the user-defined name of a VMware tag.

GetHypervisor (new) Link ¶

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

See also: AWS API Documentation

Request Syntax

client.get_hypervisor(
    HypervisorArn='string'
)
type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

rtype:

dict

returns:

Response Syntax

{
    'Hypervisor': {
        'Host': 'string',
        'HypervisorArn': 'string',
        'KmsKeyArn': 'string',
        'LastSuccessfulMetadataSyncTime': datetime(2015, 1, 1),
        'LatestMetadataSyncStatus': 'CREATED'|'RUNNING'|'FAILED'|'PARTIALLY_FAILED'|'SUCCEEDED',
        'LatestMetadataSyncStatusMessage': 'string',
        'LogGroupArn': 'string',
        'Name': 'string',
        'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
    }
}

Response Structure

  • (dict) --

    • Hypervisor (dict) --

      Details about the requested hypervisor.

      • 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 KMS used to encrypt the hypervisor.

      • LastSuccessfulMetadataSyncTime (datetime) --

        This is the time when the most recent successful sync of metadata occurred.

      • LatestMetadataSyncStatus (string) --

        This is the most recent status for the indicated metadata sync.

      • LatestMetadataSyncStatusMessage (string) --

        This is the most recent status for the indicated metadata sync.

      • LogGroupArn (string) --

        The Amazon Resource Name (ARN) of the group of gateways within the requested log.

      • Name (string) --

        This is the name of the specified hypervisor.

      • State (string) --

        This is the current state of the specified hypervisor.

        The possible states are PENDING, ONLINE, OFFLINE, or ERROR.

GetBandwidthRateLimitSchedule (new) Link ¶

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

See also: AWS API Documentation

Request Syntax

client.get_bandwidth_rate_limit_schedule(
    GatewayArn='string'
)
type GatewayArn:

string

param GatewayArn:

[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.

rtype:

dict

returns:

Response Syntax

{
    'BandwidthRateLimitIntervals': [
        {
            'AverageUploadRateLimitInBitsPerSec': 123,
            'DaysOfWeek': [
                123,
            ],
            'EndHourOfDay': 123,
            'EndMinuteOfHour': 123,
            'StartHourOfDay': 123,
            'StartMinuteOfHour': 123
        },
    ],
    'GatewayArn': 'string'
}

Response Structure

  • (dict) --

    • BandwidthRateLimitIntervals (list) --

      An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

      • (dict) --

        Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

        • AverageUploadRateLimitInBitsPerSec (integer) --

          The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

        • DaysOfWeek (list) --

          The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

          • (integer) --

        • EndHourOfDay (integer) --

          The hour of the day to end the bandwidth rate limit interval.

        • EndMinuteOfHour (integer) --

          The minute of the hour to end the bandwidth rate limit interval.

        • StartHourOfDay (integer) --

          The hour of the day to start the bandwidth rate limit interval.

        • StartMinuteOfHour (integer) --

          The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

    • 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.

StartVirtualMachinesMetadataSync (new) Link ¶

This action sends a request to sync metadata across the specified virtual machines.

See also: AWS API Documentation

Request Syntax

client.start_virtual_machines_metadata_sync(
    HypervisorArn='string'
)
type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

rtype:

dict

returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor.

GetVirtualMachine (updated) Link ¶
Changes (response) 
{'VirtualMachine': {'VmwareTags': [{'VmwareCategory': 'string',
                                    'VmwareTagDescription': 'string',
                                    'VmwareTagName': 'string'}]}}

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

See also: AWS API Documentation

Request Syntax

client.get_virtual_machine(
    ResourceArn='string'
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'VirtualMachine': {
        'HostName': 'string',
        'HypervisorId': 'string',
        'LastBackupDate': datetime(2015, 1, 1),
        'Name': 'string',
        'Path': 'string',
        'ResourceArn': 'string',
        'VmwareTags': [
            {
                'VmwareCategory': 'string',
                'VmwareTagDescription': 'string',
                'VmwareTagName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • VirtualMachine (dict) --

      This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

      • 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. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

      • VmwareTags (list) --

        These are the details of the VMware tags associated with the specified virtual machine.

        • (dict) --

          A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.

          The content of VMware tags can be matched to Amazon Web Services tags.

          • VmwareCategory (string) --

            The is the category of VMware.

          • VmwareTagDescription (string) --

            This is a user-defined description of a VMware tag.

          • VmwareTagName (string) --

            This is the user-defined name of a VMware tag.

UpdateHypervisor (updated) Link ¶
Changes (request) 
{'LogGroupArn': 'string'}

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

client.update_hypervisor(
    Host='string',
    HypervisorArn='string',
    LogGroupArn='string',
    Name='string',
    Password='string',
    Username='string'
)
type Host:

string

param Host:

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

type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

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

type LogGroupArn:

string

param LogGroupArn:

The Amazon Resource Name (ARN) of the group of gateways within the requested log.

type Name:

string

param Name:

The updated name for the hypervisor

type Password:

string

param Password:

The updated password for the hypervisor.

type Username:

string

param Username:

The updated username for the hypervisor.

rtype:

dict

returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

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