IoTThingsGraph

public struct IoTThingsGraph

Client object for interacting with AWS IoTThingsGraph service.

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.

Member variables

Initialization

  • Initialize the IoTThingsGraph client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Associates a device with a concrete thing that is in the user’s registry. A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

    Declaration

    Swift

    public func associateEntityToThing(_ input: AssociateEntityToThingRequest) -> EventLoopFuture<AssociateEntityToThingResponse>

  • Creates a workflow template. Workflows can be created only in the user’s namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user’s namespace unless another namespace version is specified in the request.

    Declaration

    Swift

    public func createFlowTemplate(_ input: CreateFlowTemplateRequest) -> EventLoopFuture<CreateFlowTemplateResponse>

  • Creates a system instance. This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action. For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller’s behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error. For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes. If the definition document doesn’t specify a version of the user’s namespace, the latest version will be used by default.

    Declaration

    Swift

    public func createSystemInstance(_ input: CreateSystemInstanceRequest) -> EventLoopFuture<CreateSystemInstanceResponse>

  • Creates a system. The system is validated against the entities in the latest version of the user’s namespace unless another namespace version is specified in the request.

    Declaration

    Swift

    public func createSystemTemplate(_ input: CreateSystemTemplateRequest) -> EventLoopFuture<CreateSystemTemplateResponse>

  • Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

    Declaration

    Swift

    public func deleteFlowTemplate(_ input: DeleteFlowTemplateRequest) -> EventLoopFuture<DeleteFlowTemplateResponse>

  • Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.

    Declaration

    Swift

    public func deleteNamespace(_ input: DeleteNamespaceRequest) -> EventLoopFuture<DeleteNamespaceResponse>

  • Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted. Users can create a new system instance that has the same ID as a deleted system instance.

    Declaration

    Swift

    public func deleteSystemInstance(_ input: DeleteSystemInstanceRequest) -> EventLoopFuture<DeleteSystemInstanceResponse>

  • Deletes a system. New deployments can’t contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

    Declaration

    Swift

    public func deleteSystemTemplate(_ input: DeleteSystemTemplateRequest) -> EventLoopFuture<DeleteSystemTemplateResponse>

  • Greengrass and Cloud Deployments Deploys the system instance to the target specified in CreateSystemInstance. Greengrass Deployments If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it. Since this action creates a Greengrass deployment on the caller’s behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error. For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

    Declaration

    Swift

    public func deploySystemInstance(_ input: DeploySystemInstanceRequest) -> EventLoopFuture<DeploySystemInstanceResponse>

  • Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can’t be deployed, but existing deployments will continue to run.

    Declaration

    Swift

    public func deprecateFlowTemplate(_ input: DeprecateFlowTemplateRequest) -> EventLoopFuture<DeprecateFlowTemplateResponse>

  • Deprecates the specified system.

    Declaration

    Swift

    public func deprecateSystemTemplate(_ input: DeprecateSystemTemplateRequest) -> EventLoopFuture<DeprecateSystemTemplateResponse>

  • Gets the latest version of the user’s namespace and the public version that it is tracking.

    Declaration

    Swift

    public func describeNamespace(_ input: DescribeNamespaceRequest) -> EventLoopFuture<DescribeNamespaceResponse>

  • Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.

    Declaration

    Swift

    public func dissociateEntityFromThing(_ input: DissociateEntityFromThingRequest) -> EventLoopFuture<DissociateEntityFromThingResponse>

  • Gets definitions of the specified entities. Uses the latest version of the user’s namespace by default. This API returns the following TDM entities. Properties States Events Actions Capabilities Mappings Devices Device Models Services This action doesn’t return definitions for systems, flows, and deployments.

    Declaration

    Swift

    public func getEntities(_ input: GetEntitiesRequest) -> EventLoopFuture<GetEntitiesResponse>

  • Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

    Declaration

    Swift

    public func getFlowTemplate(_ input: GetFlowTemplateRequest) -> EventLoopFuture<GetFlowTemplateResponse>

  • Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won’t work for workflows that have been deleted.

    Declaration

    Swift

    public func getFlowTemplateRevisions(_ input: GetFlowTemplateRevisionsRequest) -> EventLoopFuture<GetFlowTemplateRevisionsResponse>

  • Gets the status of a namespace deletion task.

    Declaration

    Swift

    public func getNamespaceDeletionStatus(_ input: GetNamespaceDeletionStatusRequest) -> EventLoopFuture<GetNamespaceDeletionStatusResponse>

  • Gets a system instance.

    Declaration

    Swift

    public func getSystemInstance(_ input: GetSystemInstanceRequest) -> EventLoopFuture<GetSystemInstanceResponse>

  • Gets a system.

    Declaration

    Swift

    public func getSystemTemplate(_ input: GetSystemTemplateRequest) -> EventLoopFuture<GetSystemTemplateResponse>

  • Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won’t work with systems that have been deleted.

    Declaration

    Swift

    public func getSystemTemplateRevisions(_ input: GetSystemTemplateRevisionsRequest) -> EventLoopFuture<GetSystemTemplateRevisionsResponse>

  • Gets the status of the specified upload.

    Declaration

    Swift

    public func getUploadStatus(_ input: GetUploadStatusRequest) -> EventLoopFuture<GetUploadStatusResponse>

  • Returns a list of objects that contain information about events in a flow execution.

    Declaration

    Swift

    public func listFlowExecutionMessages(_ input: ListFlowExecutionMessagesRequest) -> EventLoopFuture<ListFlowExecutionMessagesResponse>

  • Lists all tags on an AWS IoT Things Graph resource.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you’re tracking.

    Declaration

    Swift

    public func searchEntities(_ input: SearchEntitiesRequest) -> EventLoopFuture<SearchEntitiesResponse>

  • Searches for AWS IoT Things Graph workflow execution instances.

    Declaration

    Swift

    public func searchFlowExecutions(_ input: SearchFlowExecutionsRequest) -> EventLoopFuture<SearchFlowExecutionsResponse>

  • Searches for summary information about workflows.

    Declaration

    Swift

    public func searchFlowTemplates(_ input: SearchFlowTemplatesRequest) -> EventLoopFuture<SearchFlowTemplatesResponse>

  • Searches for system instances in the user’s account.

    Declaration

    Swift

    public func searchSystemInstances(_ input: SearchSystemInstancesRequest) -> EventLoopFuture<SearchSystemInstancesResponse>

  • Searches for summary information about systems in the user’s account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

    Declaration

    Swift

    public func searchSystemTemplates(_ input: SearchSystemTemplatesRequest) -> EventLoopFuture<SearchSystemTemplatesResponse>

  • Searches for things associated with the specified entity. You can search by both device and device model. For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2. This action searches for exact matches and doesn’t perform partial text matching.

    Declaration

    Swift

    public func searchThings(_ input: SearchThingsRequest) -> EventLoopFuture<SearchThingsResponse>

  • Creates a tag for the specified resource.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

  • Removes a system instance from its target (Cloud or Greengrass).

    Declaration

    Swift

    public func undeploySystemInstance(_ input: UndeploySystemInstanceRequest) -> EventLoopFuture<UndeploySystemInstanceResponse>

  • Removes a tag from the specified resource.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

  • Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don’t want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

    Declaration

    Swift

    public func updateFlowTemplate(_ input: UpdateFlowTemplateRequest) -> EventLoopFuture<UpdateFlowTemplateResponse>

  • Updates the specified system. You don’t need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

    Declaration

    Swift

    public func updateSystemTemplate(_ input: UpdateSystemTemplateRequest) -> EventLoopFuture<UpdateSystemTemplateResponse>

  • Asynchronously uploads one or more entity definitions to the user’s namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user’s namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded. When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true. The IDs for all of the entities should be in URN format. Each entity must be in the user’s namespace. Users can’t create entities in the public namespace, but entity definitions can refer to entities in the public namespace. Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

    Declaration

    Swift

    public func uploadEntityDefinitions(_ input: UploadEntityDefinitionsRequest) -> EventLoopFuture<UploadEntityDefinitionsResponse>

Paginators

Shapes

Enums