The Gateways API from Amazon IoT SiteWise — 4 operation(s) for gateways.
openapi: 3.0.0
info:
version: '2019-12-02'
x-release: v4
title: AWS IoT SiteWise Access Policies Gateways API
description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iotsitewise
x-aws-signingName: iotsitewise
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotsitewise-2019-12-02.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iotsitewise.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT SiteWise multi-region endpoint
- url: https://iotsitewise.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT SiteWise multi-region endpoint
- url: http://iotsitewise.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia)
- url: https://iotsitewise.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Gateways
paths:
/20200301/gateways:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateGateway
description: Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGatewayResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- gatewayName
- gatewayPlatform
properties:
gatewayName:
description: A unique, friendly name for the gateway.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
gatewayPlatform:
description: Contains a gateway's platform information.
type: object
properties:
greengrass:
allOf:
- $ref: '#/components/schemas/Greengrass'
- description: A gateway that runs on IoT Greengrass.
greengrassV2:
allOf:
- $ref: '#/components/schemas/GreengrassV2'
- description: A gateway that runs on IoT Greengrass V2.
tags:
description: A list of key-value pairs that contain metadata for the gateway. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon IoT SiteWise Create Gateway
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
get:
operationId: ListGateways
description: Retrieves a paginated list of gateways.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListGatewaysResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: nextToken
in: query
required: false
description: The token to be used for the next set of paginated results.
schema:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
- name: maxResults
in: query
required: false
description: '<p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</p>'
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT SiteWise List Gateways
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
/20200301/gateways/{gatewayId}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteGateway
description: Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
responses:
'200':
description: Success
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway to delete.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
summary: Amazon IoT SiteWise Delete Gateway
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
get:
operationId: DescribeGateway
description: Retrieves information about a gateway.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeGatewayResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway device.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
summary: Amazon IoT SiteWise Describe Gateway
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
put:
operationId: UpdateGateway
description: Updates a gateway's name.
responses:
'200':
description: Success
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
'483':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway to update.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- gatewayName
properties:
gatewayName:
description: A unique, friendly name for the gateway.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
summary: Amazon IoT SiteWise Update Gateway
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: DescribeGatewayCapabilityConfiguration
description: Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeGatewayCapabilityConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway that defines the capability configuration.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
- name: capabilityNamespace
in: path
required: true
description: 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 <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.
schema:
type: string
pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$
minLength: 1
maxLength: 512
summary: Amazon IoT SiteWise Describe Gateway Capability Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
/20200301/gateways/{gatewayId}/capability:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateGatewayCapabilityConfiguration
description: Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGatewayCapabilityConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ConflictingOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingOperationException'
'483':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
parameters:
- name: gatewayId
in: path
required: true
description: The ID of the gateway to be updated.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- capabilityNamespace
- capabilityConfiguration
properties:
capabilityNamespace:
description: The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.
type: string
pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$
minLength: 1
maxLength: 512
capabilityConfiguration:
description: The JSON document that defines the configuration for the gateway capability. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.
type: string
minLength: 1
maxLength: 104857600
summary: Amazon IoT SiteWise Update Gateway Capability Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Gateways
components:
schemas:
GatewayCapabilitySummaries:
type: array
items:
$ref: '#/components/schemas/GatewayCapabilitySummary'
CreateGatewayResponse:
type: object
required:
- gatewayId
- gatewayArn
properties:
gatewayId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.
gatewayArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <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>
CapabilitySyncStatus:
type: string
enum:
- IN_SYNC
- OUT_OF_SYNC
- SYNC_FAILED
- UNKNOWN
DescribeGatewayResponse:
type: object
required:
- gatewayId
- gatewayName
- gatewayArn
- gatewayCapabilitySummaries
- creationDate
- lastUpdateDate
properties:
gatewayId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the gateway device.
gatewayName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the gateway.
gatewayArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <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>
gatewayPlatform:
allOf:
- $ref: '#/components/schemas/GatewayPlatform'
- description: The gateway's platform.
gatewayCapabilitySummaries:
allOf:
- $ref: '#/components/schemas/GatewayCapabilitySummaries'
- description: 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>.
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the gateway was created, in Unix epoch time.
lastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the gateway was last updated, in Unix epoch time.
InternalFailureException: {}
ListGatewaysResponse:
type: object
required:
- gatewaySummaries
properties:
gatewaySummaries:
allOf:
- $ref: '#/components/schemas/GatewaySummaries'
- description: A list that summarizes each gateway.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
DescribeGatewayCapabilityConfigurationResponse:
type: object
required:
- gatewayId
- capabilityNamespace
- capabilityConfiguration
- capabilitySyncStatus
properties:
gatewayId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the gateway that defines the capability configuration.
capabilityNamespace:
allOf:
- $ref: '#/components/schemas/CapabilityNamespace'
- description: The namespace of the gateway capability.
capabilityConfiguration:
allOf:
- $ref: '#/components/schemas/CapabilityConfiguration'
- description: The JSON document that defines the gateway capability's configuration. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.
capabilitySyncStatus:
allOf:
- $ref: '#/components/schemas/CapabilitySyncStatus'
- description: <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> – The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p> </li> </ul>
Timestamp:
type: string
format: date-time
GatewaySummary:
type: object
required:
- gatewayId
- gatewayName
- creationDate
- lastUpdateDate
properties:
gatewayId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the gateway device.
gatewayName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the asset.
gatewayPlatform:
$ref: '#/components/schemas/GatewayPlatform'
gatewayCapabilitySummaries:
allOf:
- $ref: '#/components/schemas/GatewayCapabilitySummaries'
- description: 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>.
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the gateway was created, in Unix epoch time.
lastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the gateway was last updated, in Unix epoch time.
description: Contains a summary of a gateway.
TagValue:
type: string
minLength: 0
maxLength: 256
UpdateGatewayCapabilityConfigurationResponse:
type: object
required:
- capabilityNamespace
- capabilitySyncStatus
properties:
capabilityNamespace:
allOf:
- $ref: '#/components/schemas/CapabilityNamespace'
- description: The namespace of the gateway capability.
capabilitySyncStatus:
allOf:
- $ref: '#/components/schemas/CapabilitySyncStatus'
- description: <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> – The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p> </li> </ul> <p>After you update a capability configuration, its sync status is <code>OUT_OF_SYNC</code> until the gateway receives and applies or rejects the updated configuration.</p>
InvalidRequestException: {}
ConflictingOperationException: {}
LimitExceededException: {}
NextToken:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
GatewaySummaries:
type: array
items:
$ref: '#/components/schemas/GatewaySummary'
CapabilityNamespace:
type: string
pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$
minLength: 1
maxLength: 512
GatewayCapabilitySummary:
type: object
required:
- capabilityNamespace
- capabilitySyncStatus
properties:
capabilityNamespace:
allOf:
- $ref: '#/components/schemas/CapabilityNamespace'
- description: 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 <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.
capabilitySyncStatus:
allOf:
- $ref: '#/components/schemas/CapabilitySyncStatus'
- description: <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> – The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p> </li> </ul>
description: Contains a summary of a gateway capability configuration.
CoreDeviceThingName:
type: string
minLength: 1
maxLength: 128
ResourceAlreadyExistsException: {}
Name:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
ID:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
Greengrass:
type: object
required:
- groupArn
properties:
groupArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass API Reference</i>.
description: Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>.
GatewayPlatform:
type: object
properties:
greengrass:
allOf:
- $ref: '#/components/schemas/Greengrass'
- description: A gateway that runs on IoT Greengrass.
greengrassV2:
allOf:
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/openapi/amazon-iot-sitewise-gateways-api-openapi.yml