BackupGateway / Client / get_gateway

get_gateway#

BackupGateway.Client.get_gateway(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_gateway(
    GatewayArn='string'
)
Parameters:

GatewayArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway.

Return type:

dict

Returns:

Response Syntax

{
    'Gateway': {
        'GatewayArn': 'string',
        'GatewayDisplayName': 'string',
        'GatewayType': 'BACKUP_VM',
        'HypervisorId': 'string',
        'LastSeenTime': datetime(2015, 1, 1),
        'MaintenanceStartTime': {
            'DayOfMonth': 123,
            'DayOfWeek': 123,
            'HourOfDay': 123,
            'MinuteOfHour': 123
        },
        'NextUpdateAvailabilityTime': datetime(2015, 1, 1),
        'VpcEndpoint': 'string'
    }
}

Response Structure

  • (dict) –

    • Gateway (dict) –

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

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

      • HypervisorId (string) –

        The hypervisor ID of the gateway.

      • LastSeenTime (datetime) –

        Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

      • MaintenanceStartTime (dict) –

        Returns your gateway’s weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway’s time zone. Can be weekly or monthly.

        • DayOfMonth (integer) –

          The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

        • DayOfWeek (integer) –

          An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

        • HourOfDay (integer) –

          The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

        • MinuteOfHour (integer) –

          The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

      • NextUpdateAvailabilityTime (datetime) –

        Details showing the next update availability time of the gateway.

      • VpcEndpoint (string) –

        The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.ResourceNotFoundException

  • BackupGateway.Client.exceptions.ThrottlingException