AWS Storage Gateway

2021/11/30 - AWS Storage Gateway - 2 updated api methods

Changes  Added gateway type VTL_SNOW. Added new SNOWBALL HostEnvironment for gateways running on a Snowball device. Added new field HostEnvironmentId to serve as an identifier for the HostEnvironment on which the gateway is running.

DescribeGatewayInformation (updated) Link ¶
Changes (response) 
{'HostEnvironment': {'SNOWBALL'}, 'HostEnvironmentId': 'string'}

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

See also: AWS API Documentation

Request Syntax

client.describe_gateway_information(
    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

{
    'GatewayARN': 'string',
    'GatewayId': 'string',
    'GatewayName': 'string',
    'GatewayTimezone': 'string',
    'GatewayState': 'string',
    'GatewayNetworkInterfaces': [
        {
            'Ipv4Address': 'string',
            'MacAddress': 'string',
            'Ipv6Address': 'string'
        },
    ],
    'GatewayType': 'string',
    'NextUpdateAvailabilityDate': 'string',
    'LastSoftwareUpdate': 'string',
    'Ec2InstanceId': 'string',
    'Ec2InstanceRegion': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'VPCEndpoint': 'string',
    'CloudWatchLogGroupARN': 'string',
    'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
    'EndpointType': 'string',
    'SoftwareUpdatesEndDate': 'string',
    'DeprecationDate': 'string',
    'GatewayCapacity': 'Small'|'Medium'|'Large',
    'SupportedGatewayCapacities': [
        'Small'|'Medium'|'Large',
    ],
    'HostEnvironmentId': 'string'
}

Response Structure

  • (dict) --

    A JSON object containing the following fields:

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

    • GatewayId (string) --

      The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

    • GatewayName (string) --

      The name you configured for your gateway.

    • GatewayTimezone (string) --

      A value that indicates the time zone configured for the gateway.

    • GatewayState (string) --

      A value that indicates the operating state of the gateway.

    • GatewayNetworkInterfaces (list) --

      A NetworkInterface array that contains descriptions of the gateway network interfaces.

      • (dict) --

        Describes a gateway's network interface.

        • Ipv4Address (string) --

          The Internet Protocol version 4 (IPv4) address of the interface.

        • MacAddress (string) --

          The Media Access Control (MAC) address of the interface.

        • Ipv6Address (string) --

          The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

    • GatewayType (string) --

      The type of the gateway.

    • NextUpdateAvailabilityDate (string) --

      The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

    • LastSoftwareUpdate (string) --

      The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

    • Ec2InstanceId (string) --

      The ID of the Amazon EC2 instance that was used to launch the gateway.

    • Ec2InstanceRegion (string) --

      The Amazon Web Services Region where the Amazon EC2 instance is located.

    • Tags (list) --

      A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

      • (dict) --

        A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

        • Key (string) --

          Tag key. The key can't start with aws:.

        • Value (string) --

          Value of the tag key.

    • VPCEndpoint (string) --

      The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

    • CloudWatchLogGroupARN (string) --

      The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.

    • HostEnvironment (string) --

      The type of hardware or software platform on which the gateway is running.

    • EndpointType (string) --

      The type of endpoint for your gateway.

      Valid Values: STANDARD | FIPS

    • SoftwareUpdatesEndDate (string) --

      Date after which this gateway will not receive software updates for new features.

    • DeprecationDate (string) --

      Date after which this gateway will not receive software updates for new features and bug fixes.

    • GatewayCapacity (string) --

      Specifies the size of the gateway's metadata cache.

    • SupportedGatewayCapacities (list) --

      A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

      • (string) --

    • HostEnvironmentId (string) --

      A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

ListGateways (updated) Link ¶
Changes (response) 
{'Gateways': {'HostEnvironment': 'VMWARE | HYPER-V | EC2 | KVM | OTHER | '
                                 'SNOWBALL',
              'HostEnvironmentId': 'string'}}

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

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

See also: AWS API Documentation

Request Syntax

client.list_gateways(
    Marker='string',
    Limit=123
)
type Marker:

string

param Marker:

An opaque string that indicates the position at which to begin the returned list of gateways.

type Limit:

integer

param Limit:

Specifies that the list of gateways returned be limited to the specified number of items.

rtype:

dict

returns:

Response Syntax

{
    'Gateways': [
        {
            'GatewayId': 'string',
            'GatewayARN': 'string',
            'GatewayType': 'string',
            'GatewayOperationalState': 'string',
            'GatewayName': 'string',
            'Ec2InstanceId': 'string',
            'Ec2InstanceRegion': 'string',
            'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER'|'SNOWBALL',
            'HostEnvironmentId': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • Gateways (list) --

      An array of GatewayInfo objects.

      • (dict) --

        Describes a gateway object.

        • GatewayId (string) --

          The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

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

        • GatewayType (string) --

          The type of the gateway.

        • GatewayOperationalState (string) --

          The state of the gateway.

          Valid Values: DISABLED | ACTIVE

        • GatewayName (string) --

          The name of the gateway.

        • Ec2InstanceId (string) --

          The ID of the Amazon EC2 instance that was used to launch the gateway.

        • Ec2InstanceRegion (string) --

          The Amazon Web Services Region where the Amazon EC2 instance is located.

        • HostEnvironment (string) --

          The type of hardware or software platform on which the gateway is running.

        • HostEnvironmentId (string) --

          A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

    • Marker (string) --

      Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.