Skip to content

GatewayInfo

Source code in docs_src/capo_storage_gateway/types/gateway_info.py
class GatewayInfo(TypedDict, closed=True):
    gateway_id: NotRequired["capo_storage_gateway.types.gateway_id.GatewayId"]
    """<p>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.</p>"""
    gateway_arn: NotRequired["capo_storage_gateway.types.gateway_arn.GatewayARN"]
    """<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.</p>"""
    gateway_type: NotRequired["capo_storage_gateway.types.gateway_type.GatewayType"]
    """<p>The type of the gateway.</p> <important> <p>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 <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p> </important>"""
    gateway_operational_state: NotRequired[
        "capo_storage_gateway.types.gateway_operational_state.GatewayOperationalState"
    ]
    """<p>The state of the gateway.</p> <p>Valid Values: <code>DISABLED</code> | <code>ACTIVE</code> </p>"""
    gateway_name: NotRequired["capo_storage_gateway.types.string.string"]
    """<p>The name of the gateway.</p>"""
    ec2_instance_id: NotRequired[
        "capo_storage_gateway.types.ec2_instance_id.Ec2InstanceId"
    ]
    """<p>The ID of the Amazon EC2 instance that was used to launch the gateway.</p>"""
    ec2_instance_region: NotRequired[
        "capo_storage_gateway.types.ec2_instance_region.Ec2InstanceRegion"
    ]
    """<p>The Amazon Web Services Region where the Amazon EC2 instance is located.</p>"""
    host_environment: NotRequired[
        "capo_storage_gateway.types.host_environment.HostEnvironment"
    ]
    """<p>The type of hardware or software platform on which the gateway is running.</p> <note> <p>Tape Gateway is no longer available on Snow Family devices.</p> </note>"""
    host_environment_id: NotRequired[
        "capo_storage_gateway.types.host_environment_id.HostEnvironmentId"
    ]
    """<p>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.</p>"""
    deprecation_date: NotRequired[
        "capo_storage_gateway.types.deprecation_date.DeprecationDate"
    ]
    """<p>Date after which this gateway will not receive software updates for new features and bug fixes.</p>"""
    software_version: NotRequired[
        "capo_storage_gateway.types.software_version.SoftwareVersion"
    ]
    """<p>The version number of the software running on the gateway appliance.</p>"""

deprecation_date instance-attribute

deprecation_date: NotRequired[DeprecationDate]

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

ec2_instance_id instance-attribute

ec2_instance_id: NotRequired[Ec2InstanceId]

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

ec2_instance_region instance-attribute

ec2_instance_region: NotRequired[Ec2InstanceRegion]

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

gateway_arn instance-attribute

gateway_arn: NotRequired[GatewayARN]

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.

gateway_id instance-attribute

gateway_id: NotRequired[GatewayId]

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.

gateway_name instance-attribute

gateway_name: NotRequired[string]

The name of the gateway.

gateway_operational_state instance-attribute

gateway_operational_state: NotRequired[GatewayOperationalState]

The state of the gateway.

Valid Values: DISABLED | ACTIVE

gateway_type instance-attribute

gateway_type: NotRequired[GatewayType]

The type of the gateway.

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.

host_environment instance-attribute

host_environment: NotRequired[HostEnvironment]

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

Tape Gateway is no longer available on Snow Family devices.

host_environment_id instance-attribute

host_environment_id: NotRequired[HostEnvironmentId]

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.

software_version instance-attribute

software_version: NotRequired[SoftwareVersion]

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