5.0.0 • Published 5 years ago

@datafire/amazonaws_iotthingsgraph v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_iotthingsgraph

Client library for AWS IoT Things Graph

Installation and Usage

npm install --save @datafire/amazonaws_iotthingsgraph
let amazonaws_iotthingsgraph = require('@datafire/amazonaws_iotthingsgraph').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS IoT Things Graph AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level. For more information about how AWS IoT Things Graph works, see the User Guide.

Actions

AssociateEntityToThing

amazonaws_iotthingsgraph.AssociateEntityToThing({
  "thingName": null,
  "entityId": null
}, context)

Input

  • input object
    • entityId required
    • namespaceVersion
    • thingName required

Output

CreateFlowTemplate

amazonaws_iotthingsgraph.CreateFlowTemplate({
  "definition": null
}, context)

Input

  • input object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required

Output

CreateSystemInstance

amazonaws_iotthingsgraph.CreateSystemInstance({
  "definition": {
    "language": null,
    "text": null
  },
  "target": null
}, context)

Input

Output

CreateSystemTemplate

amazonaws_iotthingsgraph.CreateSystemTemplate({
  "definition": null
}, context)

Input

  • input object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required

Output

DeleteFlowTemplate

amazonaws_iotthingsgraph.DeleteFlowTemplate({
  "id": null
}, context)

Input

  • input object
    • id required

Output

DeleteNamespace

amazonaws_iotthingsgraph.DeleteNamespace({}, context)

Input

  • input object

Output

DeleteSystemInstance

amazonaws_iotthingsgraph.DeleteSystemInstance({}, context)

Input

  • input object
    • id

Output

DeleteSystemTemplate

amazonaws_iotthingsgraph.DeleteSystemTemplate({
  "id": null
}, context)

Input

  • input object
    • id required

Output

DeploySystemInstance

amazonaws_iotthingsgraph.DeploySystemInstance({}, context)

Input

  • input object
    • id

Output

DeprecateFlowTemplate

amazonaws_iotthingsgraph.DeprecateFlowTemplate({
  "id": null
}, context)

Input

  • input object
    • id required

Output

DeprecateSystemTemplate

amazonaws_iotthingsgraph.DeprecateSystemTemplate({
  "id": null
}, context)

Input

  • input object
    • id required

Output

DescribeNamespace

amazonaws_iotthingsgraph.DescribeNamespace({}, context)

Input

  • input object
    • namespaceName

Output

DissociateEntityFromThing

amazonaws_iotthingsgraph.DissociateEntityFromThing({
  "thingName": null,
  "entityType": null
}, context)

Input

  • input object
    • entityType required
    • thingName required

Output

GetEntities

amazonaws_iotthingsgraph.GetEntities({
  "ids": null
}, context)

Input

  • input object
    • ids required
    • namespaceVersion

Output

GetFlowTemplate

amazonaws_iotthingsgraph.GetFlowTemplate({
  "id": null
}, context)

Input

  • input object
    • id required
    • revisionNumber

Output

GetFlowTemplateRevisions

amazonaws_iotthingsgraph.GetFlowTemplateRevisions({
  "id": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • id required
    • maxResults
    • nextToken

Output

GetNamespaceDeletionStatus

amazonaws_iotthingsgraph.GetNamespaceDeletionStatus({}, context)

Input

  • input object

Output

GetSystemInstance

amazonaws_iotthingsgraph.GetSystemInstance({
  "id": null
}, context)

Input

  • input object
    • id required

Output

GetSystemTemplate

amazonaws_iotthingsgraph.GetSystemTemplate({
  "id": null
}, context)

Input

  • input object
    • id required
    • revisionNumber

Output

GetSystemTemplateRevisions

amazonaws_iotthingsgraph.GetSystemTemplateRevisions({
  "id": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • id required
    • maxResults
    • nextToken

Output

GetUploadStatus

amazonaws_iotthingsgraph.GetUploadStatus({
  "uploadId": null
}, context)

Input

  • input object
    • uploadId required

Output

ListFlowExecutionMessages

amazonaws_iotthingsgraph.ListFlowExecutionMessages({
  "flowExecutionId": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • flowExecutionId required
    • maxResults
    • nextToken

Output

ListTagsForResource

amazonaws_iotthingsgraph.ListTagsForResource({
  "resourceArn": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken
    • resourceArn required

Output

SearchEntities

amazonaws_iotthingsgraph.SearchEntities({
  "entityTypes": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • entityTypes required
    • filters
    • maxResults
    • namespaceVersion
    • nextToken

Output

SearchFlowExecutions

amazonaws_iotthingsgraph.SearchFlowExecutions({
  "systemInstanceId": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • endTime
    • flowExecutionId
    • maxResults
    • nextToken
    • startTime
    • systemInstanceId required

Output

SearchFlowTemplates

amazonaws_iotthingsgraph.SearchFlowTemplates({}, context)

Input

  • input object

Output

SearchSystemInstances

amazonaws_iotthingsgraph.SearchSystemInstances({}, context)

Input

Output

SearchSystemTemplates

amazonaws_iotthingsgraph.SearchSystemTemplates({}, context)

Input

Output

SearchThings

amazonaws_iotthingsgraph.SearchThings({
  "entityId": null
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • entityId required
    • maxResults
    • namespaceVersion
    • nextToken

Output

TagResource

amazonaws_iotthingsgraph.TagResource({
  "resourceArn": null,
  "tags": null
}, context)

Input

  • input object
    • tags required
    • resourceArn required

Output

UndeploySystemInstance

amazonaws_iotthingsgraph.UndeploySystemInstance({}, context)

Input

  • input object
    • id

Output

UntagResource

amazonaws_iotthingsgraph.UntagResource({
  "resourceArn": null,
  "tagKeys": null
}, context)

Input

  • input object
    • resourceArn required
    • tagKeys required

Output

UpdateFlowTemplate

amazonaws_iotthingsgraph.UpdateFlowTemplate({
  "id": null,
  "definition": null
}, context)

Input

  • input object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required
    • id required

Output

UpdateSystemTemplate

amazonaws_iotthingsgraph.UpdateSystemTemplate({
  "id": null,
  "definition": null
}, context)

Input

  • input object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required
    • id required

Output

UploadEntityDefinitions

amazonaws_iotthingsgraph.UploadEntityDefinitions({}, context)

Input

  • input object
    • deprecateExistingEntities
    • document
      • language required
      • text required
    • syncWithPublicNamespace

Output

Definitions

Arn

  • Arn string

AssociateEntityToThingRequest

  • AssociateEntityToThingRequest object
    • entityId required
    • namespaceVersion
    • thingName required

AssociateEntityToThingResponse

  • AssociateEntityToThingResponse object

CreateFlowTemplateRequest

  • CreateFlowTemplateRequest object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required

CreateFlowTemplateResponse

  • CreateFlowTemplateResponse object
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber

CreateSystemInstanceRequest

CreateSystemInstanceResponse

  • CreateSystemInstanceResponse object
    • summary
      • arn
      • createdAt
      • greengrassGroupId
      • greengrassGroupName
      • greengrassGroupVersionId
      • id
      • status
      • target
      • updatedAt

CreateSystemTemplateRequest

  • CreateSystemTemplateRequest object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required

CreateSystemTemplateResponse

  • CreateSystemTemplateResponse object
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber

DefinitionDocument

  • DefinitionDocument object: A document that defines an entity.
    • language required
    • text required

DefinitionLanguage

  • DefinitionLanguage string (values: GRAPHQL)

DefinitionText

  • DefinitionText string

DeleteFlowTemplateRequest

  • DeleteFlowTemplateRequest object
    • id required

DeleteFlowTemplateResponse

  • DeleteFlowTemplateResponse object

DeleteNamespaceRequest

  • DeleteNamespaceRequest object

DeleteNamespaceResponse

  • DeleteNamespaceResponse object
    • namespaceArn
    • namespaceName

DeleteSystemInstanceRequest

  • DeleteSystemInstanceRequest object
    • id

DeleteSystemInstanceResponse

  • DeleteSystemInstanceResponse object

DeleteSystemTemplateRequest

  • DeleteSystemTemplateRequest object
    • id required

DeleteSystemTemplateResponse

  • DeleteSystemTemplateResponse object

DependencyRevision

  • DependencyRevision object: An object that contains the ID and revision number of a workflow or system that is part of a deployment.
    • id
    • revisionNumber

DependencyRevisions

DeploySystemInstanceRequest

  • DeploySystemInstanceRequest object
    • id

DeploySystemInstanceResponse

  • DeploySystemInstanceResponse object
    • greengrassDeploymentId
    • summary required
      • arn
      • createdAt
      • greengrassGroupId
      • greengrassGroupName
      • greengrassGroupVersionId
      • id
      • status
      • target
      • updatedAt

DeploymentTarget

  • DeploymentTarget string (values: GREENGRASS, CLOUD)

DeprecateExistingEntities

  • DeprecateExistingEntities boolean

DeprecateFlowTemplateRequest

  • DeprecateFlowTemplateRequest object
    • id required

DeprecateFlowTemplateResponse

  • DeprecateFlowTemplateResponse object

DeprecateSystemTemplateRequest

  • DeprecateSystemTemplateRequest object
    • id required

DeprecateSystemTemplateResponse

  • DeprecateSystemTemplateResponse object

DescribeNamespaceRequest

  • DescribeNamespaceRequest object
    • namespaceName

DescribeNamespaceResponse

  • DescribeNamespaceResponse object
    • namespaceArn
    • namespaceName
    • namespaceVersion
    • trackingNamespaceName
    • trackingNamespaceVersion

DissociateEntityFromThingRequest

  • DissociateEntityFromThingRequest object
    • entityType required
    • thingName required

DissociateEntityFromThingResponse

  • DissociateEntityFromThingResponse object

Enabled

  • Enabled boolean

EntityDescription

  • EntityDescription object: Describes the properties of an entity.
    • arn
    • createdAt
    • definition
      • language required
      • text required
    • id
    • type

EntityDescriptions

EntityFilter

  • EntityFilter object: An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

EntityFilterName

  • EntityFilterName string (values: NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID)

EntityFilterValue

  • EntityFilterValue string

EntityFilterValues

EntityFilters

EntityType

  • EntityType string (values: DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM)

EntityTypes

FlowExecutionEventType

  • FlowExecutionEventType string (values: EXECUTION_STARTED, EXECUTION_FAILED, EXECUTION_ABORTED, EXECUTION_SUCCEEDED, STEP_STARTED, STEP_FAILED, STEP_SUCCEEDED, ACTIVITY_SCHEDULED, ACTIVITY_STARTED, ACTIVITY_FAILED, ACTIVITY_SUCCEEDED, START_FLOW_EXECUTION_TASK, SCHEDULE_NEXT_READY_STEPS_TASK, THING_ACTION_TASK, THING_ACTION_TASK_FAILED, THING_ACTION_TASK_SUCCEEDED, ACKNOWLEDGE_TASK_MESSAGE)

FlowExecutionId

  • FlowExecutionId string

FlowExecutionMessage

  • FlowExecutionMessage object: An object that contains information about a flow event.
    • eventType
    • messageId
    • payload
    • timestamp

FlowExecutionMessageId

  • FlowExecutionMessageId string

FlowExecutionMessagePayload

  • FlowExecutionMessagePayload string

FlowExecutionMessages

FlowExecutionStatus

  • FlowExecutionStatus string (values: RUNNING, ABORTED, SUCCEEDED, FAILED)

FlowExecutionSummaries

FlowExecutionSummary

  • FlowExecutionSummary object: An object that contains summary information about a flow execution.
    • createdAt
    • flowExecutionId
    • flowTemplateId
    • status
    • systemInstanceId
    • updatedAt

FlowTemplateDescription

  • FlowTemplateDescription object: An object that contains a workflow's definition and summary information.
    • definition
      • language required
      • text required
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber
    • validatedNamespaceVersion

FlowTemplateFilter

  • FlowTemplateFilter object: An object that filters a workflow search.

FlowTemplateFilterName

  • FlowTemplateFilterName string (values: DEVICE_MODEL_ID)

FlowTemplateFilterValue

  • FlowTemplateFilterValue string

FlowTemplateFilterValues

FlowTemplateFilters

FlowTemplateSummaries

FlowTemplateSummary

  • FlowTemplateSummary object: An object that contains summary information about a workflow.
    • arn
    • createdAt
    • id
    • revisionNumber

GetEntitiesRequest

  • GetEntitiesRequest object
    • ids required
    • namespaceVersion

GetEntitiesResponse

GetFlowTemplateRequest

  • GetFlowTemplateRequest object
    • id required
    • revisionNumber

GetFlowTemplateResponse

  • GetFlowTemplateResponse object
    • description
      • definition
        • language required
        • text required
      • summary
        • arn
        • createdAt
        • id
        • revisionNumber
      • validatedNamespaceVersion

GetFlowTemplateRevisionsRequest

  • GetFlowTemplateRevisionsRequest object
    • id required
    • maxResults
    • nextToken

GetFlowTemplateRevisionsResponse

GetNamespaceDeletionStatusRequest

  • GetNamespaceDeletionStatusRequest object

GetNamespaceDeletionStatusResponse

  • GetNamespaceDeletionStatusResponse object
    • errorCode
    • errorMessage
    • namespaceArn
    • namespaceName
    • status

GetSystemInstanceRequest

  • GetSystemInstanceRequest object
    • id required

GetSystemInstanceResponse

  • GetSystemInstanceResponse object
    • description

GetSystemTemplateRequest

  • GetSystemTemplateRequest object
    • id required
    • revisionNumber

GetSystemTemplateResponse

  • GetSystemTemplateResponse object
    • description
      • definition
        • language required
        • text required
      • summary
        • arn
        • createdAt
        • id
        • revisionNumber
      • validatedNamespaceVersion

GetSystemTemplateRevisionsRequest

  • GetSystemTemplateRevisionsRequest object
    • id required
    • maxResults
    • nextToken

GetSystemTemplateRevisionsResponse

GetUploadStatusRequest

  • GetUploadStatusRequest object
    • uploadId required

GetUploadStatusResponse

  • GetUploadStatusResponse object
    • createdDate required
    • failureReason
    • namespaceArn
    • namespaceName
    • namespaceVersion
    • uploadId required
    • uploadStatus required

GreengrassDeploymentId

  • GreengrassDeploymentId string

GreengrassGroupId

  • GreengrassGroupId string

GreengrassGroupVersionId

  • GreengrassGroupVersionId string

GroupName

  • GroupName string

InternalFailureException

InvalidRequestException

LimitExceededException

ListFlowExecutionMessagesRequest

  • ListFlowExecutionMessagesRequest object
    • flowExecutionId required
    • maxResults
    • nextToken

ListFlowExecutionMessagesResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • maxResults
    • nextToken
    • resourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags
    • nextToken

MaxResults

  • MaxResults integer

MetricsConfiguration

  • MetricsConfiguration object: An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
    • cloudMetricEnabled
    • metricRuleRoleArn

NamespaceDeletionStatus

  • NamespaceDeletionStatus string (values: IN_PROGRESS, SUCCEEDED, FAILED)

NamespaceDeletionStatusErrorCodes

  • NamespaceDeletionStatusErrorCodes string (values: VALIDATION_FAILED)

NamespaceName

  • NamespaceName string

NextToken

  • NextToken string

ResourceAlreadyExistsException

ResourceArn

  • ResourceArn string

ResourceInUseException

ResourceNotFoundException

RoleArn

  • RoleArn string

S3BucketName

  • S3BucketName string

SearchEntitiesRequest

  • SearchEntitiesRequest object

SearchEntitiesResponse

SearchFlowExecutionsRequest

  • SearchFlowExecutionsRequest object
    • endTime
    • flowExecutionId
    • maxResults
    • nextToken
    • startTime
    • systemInstanceId required

SearchFlowExecutionsResponse

SearchFlowTemplatesRequest

SearchFlowTemplatesResponse

SearchSystemInstancesRequest

SearchSystemInstancesResponse

SearchSystemTemplatesRequest

SearchSystemTemplatesResponse

SearchThingsRequest

  • SearchThingsRequest object
    • entityId required
    • maxResults
    • namespaceVersion
    • nextToken

SearchThingsResponse

  • SearchThingsResponse object
    • nextToken
    • things

String

  • String string

StringList

SyncWithPublicNamespace

  • SyncWithPublicNamespace boolean

SystemInstanceDeploymentStatus

  • SystemInstanceDeploymentStatus string (values: NOT_DEPLOYED, BOOTSTRAP, DEPLOY_IN_PROGRESS, DEPLOYED_IN_TARGET, UNDEPLOY_IN_PROGRESS, FAILED, PENDING_DELETE, DELETED_IN_TARGET)

SystemInstanceDescription

  • SystemInstanceDescription object: An object that contains a system instance definition and summary information.

SystemInstanceFilter

  • SystemInstanceFilter object: An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.

SystemInstanceFilterName

  • SystemInstanceFilterName string (values: SYSTEM_TEMPLATE_ID, STATUS, GREENGRASS_GROUP_NAME)

SystemInstanceFilterValue

  • SystemInstanceFilterValue string

SystemInstanceFilterValues

SystemInstanceFilters

SystemInstanceSummaries

SystemInstanceSummary

  • SystemInstanceSummary object: An object that contains summary information about a system instance.
    • arn
    • createdAt
    • greengrassGroupId
    • greengrassGroupName
    • greengrassGroupVersionId
    • id
    • status
    • target
    • updatedAt

SystemTemplateDescription

  • SystemTemplateDescription object: An object that contains a system's definition document and summary information.
    • definition
      • language required
      • text required
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber
    • validatedNamespaceVersion

SystemTemplateFilter

  • SystemTemplateFilter object: An object that filters a system search.

SystemTemplateFilterName

  • SystemTemplateFilterName string (values: FLOW_TEMPLATE_ID)

SystemTemplateFilterValue

  • SystemTemplateFilterValue string

SystemTemplateFilterValues

SystemTemplateFilters

SystemTemplateSummaries

SystemTemplateSummary

  • SystemTemplateSummary object: An object that contains information about a system.
    • arn
    • createdAt
    • id
    • revisionNumber

Tag

  • Tag object: Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
    • key required
    • value required

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • tags required
    • resourceArn required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Thing

  • Thing object: An AWS IoT thing.
    • thingArn
    • thingName

ThingArn

  • ThingArn string

ThingName

  • ThingName string

Things

ThrottlingException

Timestamp

  • Timestamp string

UndeploySystemInstanceRequest

  • UndeploySystemInstanceRequest object
    • id

UndeploySystemInstanceResponse

  • UndeploySystemInstanceResponse object
    • summary
      • arn
      • createdAt
      • greengrassGroupId
      • greengrassGroupName
      • greengrassGroupVersionId
      • id
      • status
      • target
      • updatedAt

UntagResourceRequest

  • UntagResourceRequest object
    • resourceArn required
    • tagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateFlowTemplateRequest

  • UpdateFlowTemplateRequest object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required
    • id required

UpdateFlowTemplateResponse

  • UpdateFlowTemplateResponse object
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber

UpdateSystemTemplateRequest

  • UpdateSystemTemplateRequest object
    • compatibleNamespaceVersion
    • definition required
      • language required
      • text required
    • id required

UpdateSystemTemplateResponse

  • UpdateSystemTemplateResponse object
    • summary
      • arn
      • createdAt
      • id
      • revisionNumber

UploadEntityDefinitionsRequest

  • UploadEntityDefinitionsRequest object
    • deprecateExistingEntities
    • document
      • language required
      • text required
    • syncWithPublicNamespace

UploadEntityDefinitionsResponse

  • UploadEntityDefinitionsResponse object
    • uploadId required

UploadId

  • UploadId string

UploadStatus

  • UploadStatus string (values: IN_PROGRESS, SUCCEEDED, FAILED)

Urn

  • Urn string

Urns

  • Urns array

Version

  • Version integer