AWS Storage Gateway

{'CloudWatchLogGroupARN': '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 AWS 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'
}

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

        Note

        This is currently unsupported and will not be returned in output.

      • 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 AWS 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 (String). 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 was used to monitor and log events in the gateway.

{'CloudWatchLogGroupARN': 'string'}

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

See also: AWS API Documentation

Request Syntax

client.update_gateway_information(
    GatewayARN='string',
    GatewayName='string',
    GatewayTimezone='string',
    CloudWatchLogGroupARN='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 AWS Region.

type GatewayName

string

param GatewayName

The name you configured for your gateway.

type GatewayTimezone

string

param GatewayTimezone

A value that indicates the time zone of the gateway.

type CloudWatchLogGroupARN

string

param CloudWatchLogGroupARN

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What Is Amazon CloudWatch Logs?.

rtype

dict

returns

Response Syntax

{
    'GatewayARN': 'string',
    'GatewayName': 'string'
}

Response Structure

• (dict) --

  A JSON object containing the ARN of the gateway that was updated.

  • GatewayARN (string) --

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

  • GatewayName (string) --

    The name you configured for your gateway.