Skip to content

DescribeGatewayResponse

Source code in docs_src/capo_iotsitewise/types/describe_gateway_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class DescribeGatewayResponse(TypedDict, closed=True):
    gateway_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the gateway device.</p>"""
    gateway_name: "capo_iotsitewise.types.gateway_name.GatewayName"
    """<p>The name of the gateway.</p>"""
    gateway_arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}</code> </p>"""
    gateway_platform: NotRequired[
        "capo_iotsitewise.types.gateway_platform.GatewayPlatform"
    ]
    """<p>The gateway's platform.</p>"""
    gateway_version: NotRequired[
        "capo_iotsitewise.types.gateway_version.GatewayVersion"
    ]
    """<p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3 gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>"""
    gateway_capability_summaries: (
        "capo_iotsitewise.types.gateway_capability_summaries.GatewayCapabilitySummaries"
    )
    """<p>A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>"""
    creation_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the gateway was created, in Unix epoch time.</p>"""
    last_update_date: "capo_iotsitewise.types.timestamp.Timestamp"
    """<p>The date the gateway was last updated, in Unix epoch time.</p>"""

creation_date instance-attribute 

creation_date: Timestamp

The date the gateway was created, in Unix epoch time.

gateway_arn instance-attribute 

gateway_arn: ARN

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

gateway_capability_summaries instance-attribute 

gateway_capability_summaries: GatewayCapabilitySummaries

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

gateway_id instance-attribute 

gateway_id: ID

The ID of the gateway device.

gateway_name instance-attribute 

gateway_name: GatewayName

The name of the gateway.

gateway_platform instance-attribute 

gateway_platform: NotRequired[GatewayPlatform]

The gateway's platform.

gateway_version instance-attribute 

gateway_version: NotRequired[GatewayVersion]

The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

last_update_date instance-attribute 

last_update_date: Timestamp

The date the gateway was last updated, in Unix epoch time.