StorageGateway / Client / list_gateways

list_gateways#

StorageGateway.Client.list_gateways(**kwargs)#

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

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

  • Marker (string) – An opaque string that indicates the position at which to begin the returned list of gateways.

  • Limit (integer) – Specifies that the list of gateways returned be limited to the specified number of items.

Return type:

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',
            'DeprecationDate': 'string',
            'SoftwareVersion': '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.

          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.

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

          Note

          Tape Gateway is no longer available on Snow Family devices.

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

        • DeprecationDate (string) –

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

        • SoftwareVersion (string) –

          The version number of the software running on the gateway appliance.

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

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.

response = client.list_gateways(
    Limit=2,
    Marker='1',
)

print(response)

Expected Output:

{
    'Gateways': [
        {
            'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
        },
        {
            'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C',
        },
    ],
    'Marker': '1',
    'ResponseMetadata': {
        '...': '...',
    },
}