describe_gateway

IoTSiteWise.Client.describe_gateway(**kwargs)

Retrieves information about a gateway.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway(
    gatewayId='string'
)

Parameters

gatewayId (string) --

[REQUIRED]

The ID of the gateway device.

Return type

dict

Returns

Response Syntax

{
    'gatewayId': 'string',
    'gatewayName': 'string',
    'gatewayArn': 'string',
    'gatewayPlatform': {
        'greengrass': {
            'groupArn': 'string'
        },
        'greengrassV2': {
            'coreDeviceThingName': 'string'
        }
    },
    'gatewayCapabilitySummaries': [
        {
            'capabilityNamespace': 'string',
            'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'
        },
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • gatewayId (string) --

    The ID of the gateway device.

  • gatewayName (string) --

    The name of the gateway.

  • gatewayArn (string) --

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

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

  • gatewayPlatform (dict) --

    The gateway's platform.

    • greengrass (dict) --

      A gateway that runs on IoT Greengrass.

      • groupArn (string) --

        The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference .

    • greengrassV2 (dict) --

      A gateway that runs on IoT Greengrass V2.

      • coreDeviceThingName (string) --

        The name of the IoT thing for your IoT Greengrass V2 core device.

  • gatewayCapabilitySummaries (list) --

    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.

    • (dict) --

      Contains a summary of a gateway capability configuration.

      • capabilityNamespace (string) --

        The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

      • capabilitySyncStatus (string) --

        The synchronization status of the capability configuration. The sync status can be one of the following:

        • IN_SYNC – The gateway is running the capability configuration.
        • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
        • SYNC_FAILED – The gateway rejected the capability configuration.
  • creationDate (datetime) --

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

  • lastUpdateDate (datetime) --

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

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException
• IoTSiteWise.Client.exceptions.ResourceNotFoundException
• IoTSiteWise.Client.exceptions.InternalFailureException
• IoTSiteWise.Client.exceptions.ThrottlingException