awscc.iotsitewise_gateway¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - iotsitewise:DeleteGateway
update¶
Parent base class for filters and actions.
definitions:
CapabilityConfiguration:
description: The JSON document that defines the gateway capability's configuration.
type: string
CapabilityNamespace:
description: The namespace of the capability configuration.
type: string
GatewayCapabilitySummary:
additionalProperties: false
description: Contains a summary of a gateway capability configuration.
properties:
CapabilityConfiguration:
description: The JSON document that defines the gateway capability's configuration.
type: string
CapabilityNamespace:
description: The namespace of the capability configuration.
type: string
required:
- CapabilityNamespace
type: object
GatewayPlatform:
additionalProperties: false
description: Contains a gateway's platform information.
oneOf:
- required:
- Greengrass
- required:
- GreengrassV2
properties:
Greengrass:
additionalProperties: false
description: Contains the ARN of AWS IoT Greengrass Group V1 that the gateway
runs on.
properties:
GroupArn:
description: The ARN of the Greengrass group.
type: string
required:
- GroupArn
type: object
GreengrassV2:
additionalProperties: false
description: Contains the CoreDeviceThingName of AWS IoT Greengrass Group
V2 that the gateway runs on.
properties:
CoreDeviceThingName:
description: The name of the CoreDevice in GreenGrass V2.
type: string
required:
- CoreDeviceThingName
type: object
type: object
Greengrass:
additionalProperties: false
description: Contains the ARN of AWS IoT Greengrass Group V1 that the gateway
runs on.
properties:
GroupArn:
description: The ARN of the Greengrass group.
type: string
required:
- GroupArn
type: object
GreengrassV2:
additionalProperties: false
description: Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that
the gateway runs on.
properties:
CoreDeviceThingName:
description: The name of the CoreDevice in GreenGrass V2.
type: string
required:
- CoreDeviceThingName
type: object
Tag:
additionalProperties: false
description: To add or update tag, provide both key and value. To delete tag,
provide only tag key to be deleted
properties:
Key:
type: string
Value:
type: string
required:
- Key
- Value
type: object
properties:
GatewayCapabilitySummaries:
description: A list of gateway capability summaries that each contain a namespace
and status.
insertionOrder: true
items:
additionalProperties: false
description: Contains a summary of a gateway capability configuration.
properties:
CapabilityConfiguration:
description: The JSON document that defines the gateway capability's configuration.
type: string
CapabilityNamespace:
description: The namespace of the capability configuration.
type: string
required:
- CapabilityNamespace
type: object
type: array
uniqueItems: true
GatewayName:
description: A unique, friendly name for the gateway.
type: string
Tags:
description: A list of key-value pairs that contain metadata for the gateway.
insertionOrder: false
items:
additionalProperties: false
description: To add or update tag, provide both key and value. To delete tag,
provide only tag key to be deleted
properties:
Key:
type: string
Value:
type: string
required:
- Key
- Value
type: object
type: array
uniqueItems: false
type:
enum:
- update
Permissions - iotsitewise:UpdateGateway, iotsitewise:UpdateGatewayCapabilityConfiguration, iotsitewise:TagResource, iotsitewise:UntagResource, iotsitewise:DescribeGateway, iotsitewise:ListTagsForResource