StorageGateway / Client / describe_gateway_information

describe_gateway_information#

StorageGateway.Client.describe_gateway_information(**kwargs)#

Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

response = client.describe_gateway_information(
    GatewayARN='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.

Return type:

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',
    'SoftwareVersion': '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.
      
      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.
  
  Warning
  Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
- 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
- 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. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
- HostEnvironment (string) –
  
  The type of hardware or software platform on which the gateway is running.
  
  Note
  Tape Gateway is no longer available on Snow Family devices.
- 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.
- SoftwareVersion (string) –
  
  The version number of the software running on the gateway appliance.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError

Examples

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).

response = client.describe_gateway_information(
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'GatewayId': 'sgw-AABB1122',
    'GatewayName': 'My_Gateway',
    'GatewayNetworkInterfaces': [
        {
            'Ipv4Address': '10.35.69.216',
        },
    ],
    'GatewayState': 'STATE_RUNNING',
    'GatewayTimezone': 'GMT-8:00',
    'GatewayType': 'STORED',
    'LastSoftwareUpdate': '2016-01-02T16:00:00',
    'NextUpdateAvailabilityDate': '2017-01-02T16:00:00',
    'ResponseMetadata': {
        '...': '...',
    },
}