iotthingsgraph

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 7

Documentation

Overview

Package iotthingsgraph provides the client and types for making API requests to 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 (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html).

See https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06 for more information on this service.

See iotthingsgraph package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotthingsgraph/

Using the Client

To use AWS IoT Things Graph with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Things Graph client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotthingsgraph/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT Things Graph" // Service's name
	ServiceID   = "IoTThingsGraph"       // Service's identifier
	EndpointsID = "iotthingsgraph"       // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	ErrCodeThrottlingException = "ThrottlingException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateEntityToThingInput 

type AssociateEntityToThingInput struct {

	// The ID of the device to be associated with the thing.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
	//
	// EntityId is a required field
	EntityId *string `locationName:"entityId" type:"string" required:"true"`

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`

	// The name of the thing to which the entity is to be associated.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateEntityToThingInput) String 

func (s AssociateEntityToThingInput) String() string

String returns the string representation

func (*AssociateEntityToThingInput) Validate 

func (s *AssociateEntityToThingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateEntityToThingOutput 

type AssociateEntityToThingOutput struct {
	// contains filtered or unexported fields
}

func (AssociateEntityToThingOutput) String 

func (s AssociateEntityToThingOutput) String() string

String returns the string representation

type AssociateEntityToThingRequest 

type AssociateEntityToThingRequest struct {
	*aws.Request
	Input *AssociateEntityToThingInput
	Copy  func(*AssociateEntityToThingInput) AssociateEntityToThingRequest
}

AssociateEntityToThingRequest is the request type for the AssociateEntityToThing API operation.

func (AssociateEntityToThingRequest) Send 

func (r AssociateEntityToThingRequest) Send(ctx context.Context) (*AssociateEntityToThingResponse, error)

Send marshals and sends the AssociateEntityToThing API request.

type AssociateEntityToThingResponse 

type AssociateEntityToThingResponse struct {
	*AssociateEntityToThingOutput
	// contains filtered or unexported fields
}

AssociateEntityToThingResponse is the response type for the AssociateEntityToThing API operation.

func (*AssociateEntityToThingResponse) SDKResponseMetdata 

func (r *AssociateEntityToThingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateEntityToThing request.

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Things Graph. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := iotthingsgraph.New(myConfig)

func (*Client) AssociateEntityToThingRequest 

func (c *Client) AssociateEntityToThingRequest(input *AssociateEntityToThingInput) AssociateEntityToThingRequest

AssociateEntityToThingRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using AssociateEntityToThingRequest.
req := client.AssociateEntityToThingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/AssociateEntityToThing

func (*Client) CreateFlowTemplateRequest 

func (c *Client) CreateFlowTemplateRequest(input *CreateFlowTemplateInput) CreateFlowTemplateRequest

CreateFlowTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using CreateFlowTemplateRequest.
req := client.CreateFlowTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/CreateFlowTemplate

func (*Client) CreateSystemInstanceRequest 

func (c *Client) CreateSystemInstanceRequest(input *CreateSystemInstanceInput) CreateSystemInstanceRequest

CreateSystemInstanceRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using CreateSystemInstanceRequest.
req := client.CreateSystemInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/CreateSystemInstance

func (*Client) CreateSystemTemplateRequest 

func (c *Client) CreateSystemTemplateRequest(input *CreateSystemTemplateInput) CreateSystemTemplateRequest

CreateSystemTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using CreateSystemTemplateRequest.
req := client.CreateSystemTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/CreateSystemTemplate

func (*Client) DeleteFlowTemplateRequest 

func (c *Client) DeleteFlowTemplateRequest(input *DeleteFlowTemplateInput) DeleteFlowTemplateRequest

DeleteFlowTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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). 

// Example sending a request using DeleteFlowTemplateRequest.
req := client.DeleteFlowTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeleteFlowTemplate

func (*Client) DeleteNamespaceRequest 

func (c *Client) DeleteNamespaceRequest(input *DeleteNamespaceInput) DeleteNamespaceRequest

DeleteNamespaceRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using DeleteNamespaceRequest.
req := client.DeleteNamespaceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeleteNamespace

func (*Client) DeleteSystemInstanceRequest 

func (c *Client) DeleteSystemInstanceRequest(input *DeleteSystemInstanceInput) DeleteSystemInstanceRequest

DeleteSystemInstanceRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using DeleteSystemInstanceRequest.
req := client.DeleteSystemInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeleteSystemInstance

func (*Client) DeleteSystemTemplateRequest 

func (c *Client) DeleteSystemTemplateRequest(input *DeleteSystemTemplateInput) DeleteSystemTemplateRequest

DeleteSystemTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using DeleteSystemTemplateRequest.
req := client.DeleteSystemTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeleteSystemTemplate

func (*Client) DeploySystemInstanceRequest 

func (c *Client) DeploySystemInstanceRequest(input *DeploySystemInstanceInput) DeploySystemInstanceRequest

DeploySystemInstanceRequest returns a request value for making API operation for AWS IoT Things Graph.

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 (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html). 

// Example sending a request using DeploySystemInstanceRequest.
req := client.DeploySystemInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeploySystemInstance

func (*Client) DeprecateFlowTemplateRequest 

func (c *Client) DeprecateFlowTemplateRequest(input *DeprecateFlowTemplateInput) DeprecateFlowTemplateRequest

DeprecateFlowTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using DeprecateFlowTemplateRequest.
req := client.DeprecateFlowTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeprecateFlowTemplate

func (*Client) DeprecateSystemTemplateRequest 

func (c *Client) DeprecateSystemTemplateRequest(input *DeprecateSystemTemplateInput) DeprecateSystemTemplateRequest

DeprecateSystemTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

Deprecates the specified system. 

// Example sending a request using DeprecateSystemTemplateRequest.
req := client.DeprecateSystemTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DeprecateSystemTemplate

func (*Client) DescribeNamespaceRequest 

func (c *Client) DescribeNamespaceRequest(input *DescribeNamespaceInput) DescribeNamespaceRequest

DescribeNamespaceRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using DescribeNamespaceRequest.
req := client.DescribeNamespaceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DescribeNamespace

func (*Client) DissociateEntityFromThingRequest 

func (c *Client) DissociateEntityFromThingRequest(input *DissociateEntityFromThingInput) DissociateEntityFromThingRequest

DissociateEntityFromThingRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using DissociateEntityFromThingRequest.
req := client.DissociateEntityFromThingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/DissociateEntityFromThing

func (*Client) GetEntitiesRequest 

func (c *Client) GetEntitiesRequest(input *GetEntitiesInput) GetEntitiesRequest

GetEntitiesRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using GetEntitiesRequest.
req := client.GetEntitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetEntities

func (*Client) GetFlowTemplateRequest 

func (c *Client) GetFlowTemplateRequest(input *GetFlowTemplateInput) GetFlowTemplateRequest

GetFlowTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using GetFlowTemplateRequest.
req := client.GetFlowTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetFlowTemplate

func (*Client) GetFlowTemplateRevisionsRequest 

func (c *Client) GetFlowTemplateRevisionsRequest(input *GetFlowTemplateRevisionsInput) GetFlowTemplateRevisionsRequest

GetFlowTemplateRevisionsRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using GetFlowTemplateRevisionsRequest.
req := client.GetFlowTemplateRevisionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetFlowTemplateRevisions

func (*Client) GetNamespaceDeletionStatusRequest 

func (c *Client) GetNamespaceDeletionStatusRequest(input *GetNamespaceDeletionStatusInput) GetNamespaceDeletionStatusRequest

GetNamespaceDeletionStatusRequest returns a request value for making API operation for AWS IoT Things Graph.

Gets the status of a namespace deletion task. 

// Example sending a request using GetNamespaceDeletionStatusRequest.
req := client.GetNamespaceDeletionStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetNamespaceDeletionStatus

func (*Client) GetSystemInstanceRequest 

func (c *Client) GetSystemInstanceRequest(input *GetSystemInstanceInput) GetSystemInstanceRequest

GetSystemInstanceRequest returns a request value for making API operation for AWS IoT Things Graph.

Gets a system instance. 

// Example sending a request using GetSystemInstanceRequest.
req := client.GetSystemInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetSystemInstance

func (*Client) GetSystemTemplateRequest 

func (c *Client) GetSystemTemplateRequest(input *GetSystemTemplateInput) GetSystemTemplateRequest

GetSystemTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

Gets a system. 

// Example sending a request using GetSystemTemplateRequest.
req := client.GetSystemTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetSystemTemplate

func (*Client) GetSystemTemplateRevisionsRequest 

func (c *Client) GetSystemTemplateRevisionsRequest(input *GetSystemTemplateRevisionsInput) GetSystemTemplateRevisionsRequest

GetSystemTemplateRevisionsRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using GetSystemTemplateRevisionsRequest.
req := client.GetSystemTemplateRevisionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetSystemTemplateRevisions

func (*Client) GetUploadStatusRequest 

func (c *Client) GetUploadStatusRequest(input *GetUploadStatusInput) GetUploadStatusRequest

GetUploadStatusRequest returns a request value for making API operation for AWS IoT Things Graph.

Gets the status of the specified upload. 

// Example sending a request using GetUploadStatusRequest.
req := client.GetUploadStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/GetUploadStatus

func (*Client) ListFlowExecutionMessagesRequest 

func (c *Client) ListFlowExecutionMessagesRequest(input *ListFlowExecutionMessagesInput) ListFlowExecutionMessagesRequest

ListFlowExecutionMessagesRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using ListFlowExecutionMessagesRequest.
req := client.ListFlowExecutionMessagesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/ListFlowExecutionMessages

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS IoT Things Graph.

Lists all tags on an AWS IoT Things Graph resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/ListTagsForResource

func (*Client) SearchEntitiesRequest 

func (c *Client) SearchEntitiesRequest(input *SearchEntitiesInput) SearchEntitiesRequest

SearchEntitiesRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using SearchEntitiesRequest.
req := client.SearchEntitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchEntities

func (*Client) SearchFlowExecutionsRequest 

func (c *Client) SearchFlowExecutionsRequest(input *SearchFlowExecutionsInput) SearchFlowExecutionsRequest

SearchFlowExecutionsRequest returns a request value for making API operation for AWS IoT Things Graph.

Searches for AWS IoT Things Graph workflow execution instances. 

// Example sending a request using SearchFlowExecutionsRequest.
req := client.SearchFlowExecutionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchFlowExecutions

func (*Client) SearchFlowTemplatesRequest 

func (c *Client) SearchFlowTemplatesRequest(input *SearchFlowTemplatesInput) SearchFlowTemplatesRequest

SearchFlowTemplatesRequest returns a request value for making API operation for AWS IoT Things Graph.

Searches for summary information about workflows. 

// Example sending a request using SearchFlowTemplatesRequest.
req := client.SearchFlowTemplatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchFlowTemplates

func (*Client) SearchSystemInstancesRequest 

func (c *Client) SearchSystemInstancesRequest(input *SearchSystemInstancesInput) SearchSystemInstancesRequest

SearchSystemInstancesRequest returns a request value for making API operation for AWS IoT Things Graph.

Searches for system instances in the user's account. 

// Example sending a request using SearchSystemInstancesRequest.
req := client.SearchSystemInstancesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchSystemInstances

func (*Client) SearchSystemTemplatesRequest 

func (c *Client) SearchSystemTemplatesRequest(input *SearchSystemTemplatesInput) SearchSystemTemplatesRequest

SearchSystemTemplatesRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using SearchSystemTemplatesRequest.
req := client.SearchSystemTemplatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchSystemTemplates

func (*Client) SearchThingsRequest 

func (c *Client) SearchThingsRequest(input *SearchThingsInput) SearchThingsRequest

SearchThingsRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using SearchThingsRequest.
req := client.SearchThingsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchThings

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS IoT Things Graph.

Creates a tag for the specified resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/TagResource

func (*Client) UndeploySystemInstanceRequest 

func (c *Client) UndeploySystemInstanceRequest(input *UndeploySystemInstanceInput) UndeploySystemInstanceRequest

UndeploySystemInstanceRequest returns a request value for making API operation for AWS IoT Things Graph.

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

// Example sending a request using UndeploySystemInstanceRequest.
req := client.UndeploySystemInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UndeploySystemInstance

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS IoT Things Graph.

Removes a tag from the specified resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UntagResource

func (*Client) UpdateFlowTemplateRequest 

func (c *Client) UpdateFlowTemplateRequest(input *UpdateFlowTemplateInput) UpdateFlowTemplateRequest

UpdateFlowTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using UpdateFlowTemplateRequest.
req := client.UpdateFlowTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UpdateFlowTemplate

func (*Client) UpdateSystemTemplateRequest 

func (c *Client) UpdateSystemTemplateRequest(input *UpdateSystemTemplateInput) UpdateSystemTemplateRequest

UpdateSystemTemplateRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using UpdateSystemTemplateRequest.
req := client.UpdateSystemTemplateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UpdateSystemTemplate

func (*Client) UploadEntityDefinitionsRequest 

func (c *Client) UploadEntityDefinitionsRequest(input *UploadEntityDefinitionsInput) UploadEntityDefinitionsRequest

UploadEntityDefinitionsRequest returns a request value for making API operation for AWS IoT Things Graph.

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. 

// Example sending a request using UploadEntityDefinitionsRequest.
req := client.UploadEntityDefinitionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UploadEntityDefinitions

type CreateFlowTemplateInput 

type CreateFlowTemplateInput struct {

	// The namespace version in which the workflow is to be created.
	//
	// If no value is specified, the latest version is used by default.
	CompatibleNamespaceVersion *int64 `locationName:"compatibleNamespaceVersion" type:"long"`

	// The workflow DefinitionDocument.
	//
	// Definition is a required field
	Definition *DefinitionDocument `locationName:"definition" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFlowTemplateInput) String 

func (s CreateFlowTemplateInput) String() string

String returns the string representation

func (*CreateFlowTemplateInput) Validate 

func (s *CreateFlowTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFlowTemplateOutput 

type CreateFlowTemplateOutput struct {

	// The summary object that describes the created workflow.
	Summary *FlowTemplateSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFlowTemplateOutput) String 

func (s CreateFlowTemplateOutput) String() string

String returns the string representation

type CreateFlowTemplateRequest 

type CreateFlowTemplateRequest struct {
	*aws.Request
	Input *CreateFlowTemplateInput
	Copy  func(*CreateFlowTemplateInput) CreateFlowTemplateRequest
}

CreateFlowTemplateRequest is the request type for the CreateFlowTemplate API operation.

func (CreateFlowTemplateRequest) Send 

func (r CreateFlowTemplateRequest) Send(ctx context.Context) (*CreateFlowTemplateResponse, error)

Send marshals and sends the CreateFlowTemplate API request.

type CreateFlowTemplateResponse 

type CreateFlowTemplateResponse struct {
	*CreateFlowTemplateOutput
	// contains filtered or unexported fields
}

CreateFlowTemplateResponse is the response type for the CreateFlowTemplate API operation.

func (*CreateFlowTemplateResponse) SDKResponseMetdata 

func (r *CreateFlowTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFlowTemplate request.

type CreateSystemInstanceInput 

type CreateSystemInstanceInput struct {

	// A document that defines an entity.
	//
	// Definition is a required field
	Definition *DefinitionDocument `locationName:"definition" type:"structure" required:"true"`

	// The ARN of the IAM role that AWS IoT Things Graph will assume when it executes
	// the flow. This role must have read and write access to AWS Lambda and AWS
	// IoT and any other AWS services that the flow uses when it executes. This
	// value is required if the value of the target parameter is CLOUD.
	FlowActionsRoleArn *string `locationName:"flowActionsRoleArn" min:"20" type:"string"`

	// The name of the Greengrass group where the system instance will be deployed.
	// This value is required if the value of the target parameter is GREENGRASS.
	GreengrassGroupName *string `locationName:"greengrassGroupName" type:"string"`

	// An object that specifies whether cloud metrics are collected in a deployment
	// and, if so, what role is used to collect metrics.
	MetricsConfiguration *MetricsConfiguration `locationName:"metricsConfiguration" type:"structure"`

	// The name of the Amazon Simple Storage Service bucket that will be used to
	// store and deploy the system instance's resource file. This value is required
	// if the value of the target parameter is GREENGRASS.
	S3BucketName *string `locationName:"s3BucketName" type:"string"`

	// Metadata, consisting of key-value pairs, that can be used to categorize your
	// system instances.
	Tags []Tag `locationName:"tags" type:"list"`

	// The target type of the deployment. Valid values are GREENGRASS and CLOUD.
	//
	// Target is a required field
	Target DeploymentTarget `locationName:"target" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateSystemInstanceInput) String 

func (s CreateSystemInstanceInput) String() string

String returns the string representation

func (*CreateSystemInstanceInput) Validate 

func (s *CreateSystemInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSystemInstanceOutput 

type CreateSystemInstanceOutput struct {

	// The summary object that describes the new system instance.
	Summary *SystemInstanceSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSystemInstanceOutput) String 

func (s CreateSystemInstanceOutput) String() string

String returns the string representation

type CreateSystemInstanceRequest 

type CreateSystemInstanceRequest struct {
	*aws.Request
	Input *CreateSystemInstanceInput
	Copy  func(*CreateSystemInstanceInput) CreateSystemInstanceRequest
}

CreateSystemInstanceRequest is the request type for the CreateSystemInstance API operation.

func (CreateSystemInstanceRequest) Send 

func (r CreateSystemInstanceRequest) Send(ctx context.Context) (*CreateSystemInstanceResponse, error)

Send marshals and sends the CreateSystemInstance API request.

type CreateSystemInstanceResponse 

type CreateSystemInstanceResponse struct {
	*CreateSystemInstanceOutput
	// contains filtered or unexported fields
}

CreateSystemInstanceResponse is the response type for the CreateSystemInstance API operation.

func (*CreateSystemInstanceResponse) SDKResponseMetdata 

func (r *CreateSystemInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSystemInstance request.

type CreateSystemTemplateInput 

type CreateSystemTemplateInput struct {

	// The namespace version in which the system is to be created.
	//
	// If no value is specified, the latest version is used by default.
	CompatibleNamespaceVersion *int64 `locationName:"compatibleNamespaceVersion" type:"long"`

	// The DefinitionDocument used to create the system.
	//
	// Definition is a required field
	Definition *DefinitionDocument `locationName:"definition" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSystemTemplateInput) String 

func (s CreateSystemTemplateInput) String() string

String returns the string representation

func (*CreateSystemTemplateInput) Validate 

func (s *CreateSystemTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSystemTemplateOutput 

type CreateSystemTemplateOutput struct {

	// The summary object that describes the created system.
	Summary *SystemTemplateSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSystemTemplateOutput) String 

func (s CreateSystemTemplateOutput) String() string

String returns the string representation

type CreateSystemTemplateRequest 

type CreateSystemTemplateRequest struct {
	*aws.Request
	Input *CreateSystemTemplateInput
	Copy  func(*CreateSystemTemplateInput) CreateSystemTemplateRequest
}

CreateSystemTemplateRequest is the request type for the CreateSystemTemplate API operation.

func (CreateSystemTemplateRequest) Send 

func (r CreateSystemTemplateRequest) Send(ctx context.Context) (*CreateSystemTemplateResponse, error)

Send marshals and sends the CreateSystemTemplate API request.

type CreateSystemTemplateResponse 

type CreateSystemTemplateResponse struct {
	*CreateSystemTemplateOutput
	// contains filtered or unexported fields
}

CreateSystemTemplateResponse is the response type for the CreateSystemTemplate API operation.

func (*CreateSystemTemplateResponse) SDKResponseMetdata 

func (r *CreateSystemTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSystemTemplate request.

type DefinitionDocument 

type DefinitionDocument struct {

	// The language used to define the entity. GRAPHQL is the only valid value.
	//
	// Language is a required field
	Language DefinitionLanguage `locationName:"language" type:"string" required:"true" enum:"true"`

	// The GraphQL text that defines the entity.
	//
	// Text is a required field
	Text *string `locationName:"text" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A document that defines an entity.

func (DefinitionDocument) String 

func (s DefinitionDocument) String() string

String returns the string representation

func (*DefinitionDocument) Validate 

func (s *DefinitionDocument) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DefinitionLanguage 

type DefinitionLanguage string
const (
	DefinitionLanguageGraphql DefinitionLanguage = "GRAPHQL"
)

Enum values for DefinitionLanguage

func (DefinitionLanguage) MarshalValue 

func (enum DefinitionLanguage) MarshalValue() (string, error)

func (DefinitionLanguage) MarshalValueBuf 

func (enum DefinitionLanguage) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteFlowTemplateInput 

type DeleteFlowTemplateInput struct {

	// The ID of the workflow to be deleted.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowTemplateInput) String 

func (s DeleteFlowTemplateInput) String() string

String returns the string representation

func (*DeleteFlowTemplateInput) Validate 

func (s *DeleteFlowTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFlowTemplateOutput 

type DeleteFlowTemplateOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFlowTemplateOutput) String 

func (s DeleteFlowTemplateOutput) String() string

String returns the string representation

type DeleteFlowTemplateRequest 

type DeleteFlowTemplateRequest struct {
	*aws.Request
	Input *DeleteFlowTemplateInput
	Copy  func(*DeleteFlowTemplateInput) DeleteFlowTemplateRequest
}

DeleteFlowTemplateRequest is the request type for the DeleteFlowTemplate API operation.

func (DeleteFlowTemplateRequest) Send 

func (r DeleteFlowTemplateRequest) Send(ctx context.Context) (*DeleteFlowTemplateResponse, error)

Send marshals and sends the DeleteFlowTemplate API request.

type DeleteFlowTemplateResponse 

type DeleteFlowTemplateResponse struct {
	*DeleteFlowTemplateOutput
	// contains filtered or unexported fields
}

DeleteFlowTemplateResponse is the response type for the DeleteFlowTemplate API operation.

func (*DeleteFlowTemplateResponse) SDKResponseMetdata 

func (r *DeleteFlowTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFlowTemplate request.

type DeleteNamespaceInput 

type DeleteNamespaceInput struct {
	// contains filtered or unexported fields
}

func (DeleteNamespaceInput) String 

func (s DeleteNamespaceInput) String() string

String returns the string representation

type DeleteNamespaceOutput 

type DeleteNamespaceOutput struct {

	// The ARN of the namespace to be deleted.
	NamespaceArn *string `locationName:"namespaceArn" type:"string"`

	// The name of the namespace to be deleted.
	NamespaceName *string `locationName:"namespaceName" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteNamespaceOutput) String 

func (s DeleteNamespaceOutput) String() string

String returns the string representation

type DeleteNamespaceRequest 

type DeleteNamespaceRequest struct {
	*aws.Request
	Input *DeleteNamespaceInput
	Copy  func(*DeleteNamespaceInput) DeleteNamespaceRequest
}

DeleteNamespaceRequest is the request type for the DeleteNamespace API operation.

func (DeleteNamespaceRequest) Send 

func (r DeleteNamespaceRequest) Send(ctx context.Context) (*DeleteNamespaceResponse, error)

Send marshals and sends the DeleteNamespace API request.

type DeleteNamespaceResponse 

type DeleteNamespaceResponse struct {
	*DeleteNamespaceOutput
	// contains filtered or unexported fields
}

DeleteNamespaceResponse is the response type for the DeleteNamespace API operation.

func (*DeleteNamespaceResponse) SDKResponseMetdata 

func (r *DeleteNamespaceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteNamespace request.

type DeleteSystemInstanceInput 

type DeleteSystemInstanceInput struct {

	// The ID of the system instance to be deleted.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSystemInstanceInput) String 

func (s DeleteSystemInstanceInput) String() string

String returns the string representation

type DeleteSystemInstanceOutput 

type DeleteSystemInstanceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSystemInstanceOutput) String 

func (s DeleteSystemInstanceOutput) String() string

String returns the string representation

type DeleteSystemInstanceRequest 

type DeleteSystemInstanceRequest struct {
	*aws.Request
	Input *DeleteSystemInstanceInput
	Copy  func(*DeleteSystemInstanceInput) DeleteSystemInstanceRequest
}

DeleteSystemInstanceRequest is the request type for the DeleteSystemInstance API operation.

func (DeleteSystemInstanceRequest) Send 

func (r DeleteSystemInstanceRequest) Send(ctx context.Context) (*DeleteSystemInstanceResponse, error)

Send marshals and sends the DeleteSystemInstance API request.

type DeleteSystemInstanceResponse 

type DeleteSystemInstanceResponse struct {
	*DeleteSystemInstanceOutput
	// contains filtered or unexported fields
}

DeleteSystemInstanceResponse is the response type for the DeleteSystemInstance API operation.

func (*DeleteSystemInstanceResponse) SDKResponseMetdata 

func (r *DeleteSystemInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSystemInstance request.

type DeleteSystemTemplateInput 

type DeleteSystemTemplateInput struct {

	// The ID of the system to be deleted.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSystemTemplateInput) String 

func (s DeleteSystemTemplateInput) String() string

String returns the string representation

func (*DeleteSystemTemplateInput) Validate 

func (s *DeleteSystemTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSystemTemplateOutput 

type DeleteSystemTemplateOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSystemTemplateOutput) String 

func (s DeleteSystemTemplateOutput) String() string

String returns the string representation

type DeleteSystemTemplateRequest 

type DeleteSystemTemplateRequest struct {
	*aws.Request
	Input *DeleteSystemTemplateInput
	Copy  func(*DeleteSystemTemplateInput) DeleteSystemTemplateRequest
}

DeleteSystemTemplateRequest is the request type for the DeleteSystemTemplate API operation.

func (DeleteSystemTemplateRequest) Send 

func (r DeleteSystemTemplateRequest) Send(ctx context.Context) (*DeleteSystemTemplateResponse, error)

Send marshals and sends the DeleteSystemTemplate API request.

type DeleteSystemTemplateResponse 

type DeleteSystemTemplateResponse struct {
	*DeleteSystemTemplateOutput
	// contains filtered or unexported fields
}

DeleteSystemTemplateResponse is the response type for the DeleteSystemTemplate API operation.

func (*DeleteSystemTemplateResponse) SDKResponseMetdata 

func (r *DeleteSystemTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSystemTemplate request.

type DependencyRevision 

type DependencyRevision struct {

	// The ID of the workflow or system.
	Id *string `locationName:"id" type:"string"`

	// The revision number of the workflow or system.
	RevisionNumber *int64 `locationName:"revisionNumber" type:"long"`
	// contains filtered or unexported fields
}

An object that contains the ID and revision number of a workflow or system that is part of a deployment.

func (DependencyRevision) String 

func (s DependencyRevision) String() string

String returns the string representation

type DeploySystemInstanceInput 

type DeploySystemInstanceInput struct {

	// The ID of the system instance. This value is returned by the CreateSystemInstance
	// action.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

func (DeploySystemInstanceInput) String 

func (s DeploySystemInstanceInput) String() string

String returns the string representation

type DeploySystemInstanceOutput 

type DeploySystemInstanceOutput struct {

	// The ID of the Greengrass deployment used to deploy the system instance.
	GreengrassDeploymentId *string `locationName:"greengrassDeploymentId" type:"string"`

	// An object that contains summary information about a system instance that
	// was deployed.
	//
	// Summary is a required field
	Summary *SystemInstanceSummary `locationName:"summary" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeploySystemInstanceOutput) String 

func (s DeploySystemInstanceOutput) String() string

String returns the string representation

type DeploySystemInstanceRequest 

type DeploySystemInstanceRequest struct {
	*aws.Request
	Input *DeploySystemInstanceInput
	Copy  func(*DeploySystemInstanceInput) DeploySystemInstanceRequest
}

DeploySystemInstanceRequest is the request type for the DeploySystemInstance API operation.

func (DeploySystemInstanceRequest) Send 

func (r DeploySystemInstanceRequest) Send(ctx context.Context) (*DeploySystemInstanceResponse, error)

Send marshals and sends the DeploySystemInstance API request.

type DeploySystemInstanceResponse 

type DeploySystemInstanceResponse struct {
	*DeploySystemInstanceOutput
	// contains filtered or unexported fields
}

DeploySystemInstanceResponse is the response type for the DeploySystemInstance API operation.

func (*DeploySystemInstanceResponse) SDKResponseMetdata 

func (r *DeploySystemInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeploySystemInstance request.

type DeploymentTarget 

type DeploymentTarget string
const (
	DeploymentTargetGreengrass DeploymentTarget = "GREENGRASS"
	DeploymentTargetCloud      DeploymentTarget = "CLOUD"
)

Enum values for DeploymentTarget

func (DeploymentTarget) MarshalValue 

func (enum DeploymentTarget) MarshalValue() (string, error)

func (DeploymentTarget) MarshalValueBuf 

func (enum DeploymentTarget) MarshalValueBuf(b []byte) ([]byte, error)

type DeprecateFlowTemplateInput 

type DeprecateFlowTemplateInput struct {

	// The ID of the workflow to be deleted.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeprecateFlowTemplateInput) String 

func (s DeprecateFlowTemplateInput) String() string

String returns the string representation

func (*DeprecateFlowTemplateInput) Validate 

func (s *DeprecateFlowTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeprecateFlowTemplateOutput 

type DeprecateFlowTemplateOutput struct {
	// contains filtered or unexported fields
}

func (DeprecateFlowTemplateOutput) String 

func (s DeprecateFlowTemplateOutput) String() string

String returns the string representation

type DeprecateFlowTemplateRequest 

type DeprecateFlowTemplateRequest struct {
	*aws.Request
	Input *DeprecateFlowTemplateInput
	Copy  func(*DeprecateFlowTemplateInput) DeprecateFlowTemplateRequest
}

DeprecateFlowTemplateRequest is the request type for the DeprecateFlowTemplate API operation.

func (DeprecateFlowTemplateRequest) Send 

func (r DeprecateFlowTemplateRequest) Send(ctx context.Context) (*DeprecateFlowTemplateResponse, error)

Send marshals and sends the DeprecateFlowTemplate API request.

type DeprecateFlowTemplateResponse 

type DeprecateFlowTemplateResponse struct {
	*DeprecateFlowTemplateOutput
	// contains filtered or unexported fields
}

DeprecateFlowTemplateResponse is the response type for the DeprecateFlowTemplate API operation.

func (*DeprecateFlowTemplateResponse) SDKResponseMetdata 

func (r *DeprecateFlowTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeprecateFlowTemplate request.

type DeprecateSystemTemplateInput 

type DeprecateSystemTemplateInput struct {

	// The ID of the system to delete.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeprecateSystemTemplateInput) String 

func (s DeprecateSystemTemplateInput) String() string

String returns the string representation

func (*DeprecateSystemTemplateInput) Validate 

func (s *DeprecateSystemTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeprecateSystemTemplateOutput 

type DeprecateSystemTemplateOutput struct {
	// contains filtered or unexported fields
}

func (DeprecateSystemTemplateOutput) String 

func (s DeprecateSystemTemplateOutput) String() string

String returns the string representation

type DeprecateSystemTemplateRequest 

type DeprecateSystemTemplateRequest struct {
	*aws.Request
	Input *DeprecateSystemTemplateInput
	Copy  func(*DeprecateSystemTemplateInput) DeprecateSystemTemplateRequest
}

DeprecateSystemTemplateRequest is the request type for the DeprecateSystemTemplate API operation.

func (DeprecateSystemTemplateRequest) Send 

func (r DeprecateSystemTemplateRequest) Send(ctx context.Context) (*DeprecateSystemTemplateResponse, error)

Send marshals and sends the DeprecateSystemTemplate API request.

type DeprecateSystemTemplateResponse 

type DeprecateSystemTemplateResponse struct {
	*DeprecateSystemTemplateOutput
	// contains filtered or unexported fields
}

DeprecateSystemTemplateResponse is the response type for the DeprecateSystemTemplate API operation.

func (*DeprecateSystemTemplateResponse) SDKResponseMetdata 

func (r *DeprecateSystemTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeprecateSystemTemplate request.

type DescribeNamespaceInput 

type DescribeNamespaceInput struct {

	// The name of the user's namespace. Set this to aws to get the public namespace.
	NamespaceName *string `locationName:"namespaceName" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeNamespaceInput) String 

func (s DescribeNamespaceInput) String() string

String returns the string representation

type DescribeNamespaceOutput 

type DescribeNamespaceOutput struct {

	// The ARN of the namespace.
	NamespaceArn *string `locationName:"namespaceArn" type:"string"`

	// The name of the namespace.
	NamespaceName *string `locationName:"namespaceName" type:"string"`

	// The version of the user's namespace to describe.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`

	// The name of the public namespace that the latest namespace version is tracking.
	TrackingNamespaceName *string `locationName:"trackingNamespaceName" type:"string"`

	// The version of the public namespace that the latest version is tracking.
	TrackingNamespaceVersion *int64 `locationName:"trackingNamespaceVersion" type:"long"`
	// contains filtered or unexported fields
}

func (DescribeNamespaceOutput) String 

func (s DescribeNamespaceOutput) String() string

String returns the string representation

type DescribeNamespaceRequest 

type DescribeNamespaceRequest struct {
	*aws.Request
	Input *DescribeNamespaceInput
	Copy  func(*DescribeNamespaceInput) DescribeNamespaceRequest
}

DescribeNamespaceRequest is the request type for the DescribeNamespace API operation.

func (DescribeNamespaceRequest) Send 

func (r DescribeNamespaceRequest) Send(ctx context.Context) (*DescribeNamespaceResponse, error)

Send marshals and sends the DescribeNamespace API request.

type DescribeNamespaceResponse 

type DescribeNamespaceResponse struct {
	*DescribeNamespaceOutput
	// contains filtered or unexported fields
}

DescribeNamespaceResponse is the response type for the DescribeNamespace API operation.

func (*DescribeNamespaceResponse) SDKResponseMetdata 

func (r *DescribeNamespaceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeNamespace request.

type DissociateEntityFromThingInput 

type DissociateEntityFromThingInput struct {

	// The entity type from which to disassociate the thing.
	//
	// EntityType is a required field
	EntityType EntityType `locationName:"entityType" type:"string" required:"true" enum:"true"`

	// The name of the thing to disassociate.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DissociateEntityFromThingInput) String 

func (s DissociateEntityFromThingInput) String() string

String returns the string representation

func (*DissociateEntityFromThingInput) Validate 

func (s *DissociateEntityFromThingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DissociateEntityFromThingOutput 

type DissociateEntityFromThingOutput struct {
	// contains filtered or unexported fields
}

func (DissociateEntityFromThingOutput) String 

func (s DissociateEntityFromThingOutput) String() string

String returns the string representation

type DissociateEntityFromThingRequest 

type DissociateEntityFromThingRequest struct {
	*aws.Request
	Input *DissociateEntityFromThingInput
	Copy  func(*DissociateEntityFromThingInput) DissociateEntityFromThingRequest
}

DissociateEntityFromThingRequest is the request type for the DissociateEntityFromThing API operation.

func (DissociateEntityFromThingRequest) Send 

func (r DissociateEntityFromThingRequest) Send(ctx context.Context) (*DissociateEntityFromThingResponse, error)

Send marshals and sends the DissociateEntityFromThing API request.

type DissociateEntityFromThingResponse 

type DissociateEntityFromThingResponse struct {
	*DissociateEntityFromThingOutput
	// contains filtered or unexported fields
}

DissociateEntityFromThingResponse is the response type for the DissociateEntityFromThing API operation.

func (*DissociateEntityFromThingResponse) SDKResponseMetdata 

func (r *DissociateEntityFromThingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DissociateEntityFromThing request.

type EntityDescription 

type EntityDescription struct {

	// The entity ARN.
	Arn *string `locationName:"arn" type:"string"`

	// The time at which the entity was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The definition document of the entity.
	Definition *DefinitionDocument `locationName:"definition" type:"structure"`

	// The entity ID.
	Id *string `locationName:"id" type:"string"`

	// The entity type.
	Type EntityType `locationName:"type" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes the properties of an entity.

func (EntityDescription) String 

func (s EntityDescription) String() string

String returns the string representation

type EntityFilter 

type EntityFilter struct {

	// The name of the entity search filter field. REFERENCED_ENTITY_ID filters
	// on entities that are used by the entity in the result set. For example, you
	// can filter on the ID of a property that is used in a state.
	Name EntityFilterName `locationName:"name" type:"string" enum:"true"`

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []string `locationName:"value" type:"list"`
	// contains filtered or unexported fields
}

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.

func (EntityFilter) String 

func (s EntityFilter) String() string

String returns the string representation

type EntityFilterName 

type EntityFilterName string
const (
	EntityFilterNameName               EntityFilterName = "NAME"
	EntityFilterNameNamespace          EntityFilterName = "NAMESPACE"
	EntityFilterNameSemanticTypePath   EntityFilterName = "SEMANTIC_TYPE_PATH"
	EntityFilterNameReferencedEntityId EntityFilterName = "REFERENCED_ENTITY_ID"
)

Enum values for EntityFilterName

func (EntityFilterName) MarshalValue 

func (enum EntityFilterName) MarshalValue() (string, error)

func (EntityFilterName) MarshalValueBuf 

func (enum EntityFilterName) MarshalValueBuf(b []byte) ([]byte, error)

type EntityType 

type EntityType string
const (
	EntityTypeDevice      EntityType = "DEVICE"
	EntityTypeService     EntityType = "SERVICE"
	EntityTypeDeviceModel EntityType = "DEVICE_MODEL"
	EntityTypeCapability  EntityType = "CAPABILITY"
	EntityTypeState       EntityType = "STATE"
	EntityTypeAction      EntityType = "ACTION"
	EntityTypeEvent       EntityType = "EVENT"
	EntityTypeProperty    EntityType = "PROPERTY"
	EntityTypeMapping     EntityType = "MAPPING"
	EntityTypeEnum        EntityType = "ENUM"
)

Enum values for EntityType

func (EntityType) MarshalValue 

func (enum EntityType) MarshalValue() (string, error)

func (EntityType) MarshalValueBuf 

func (enum EntityType) MarshalValueBuf(b []byte) ([]byte, error)

type FlowExecutionEventType 

type FlowExecutionEventType string
const (
	FlowExecutionEventTypeExecutionStarted           FlowExecutionEventType = "EXECUTION_STARTED"
	FlowExecutionEventTypeExecutionFailed            FlowExecutionEventType = "EXECUTION_FAILED"
	FlowExecutionEventTypeExecutionAborted           FlowExecutionEventType = "EXECUTION_ABORTED"
	FlowExecutionEventTypeExecutionSucceeded         FlowExecutionEventType = "EXECUTION_SUCCEEDED"
	FlowExecutionEventTypeStepStarted                FlowExecutionEventType = "STEP_STARTED"
	FlowExecutionEventTypeStepFailed                 FlowExecutionEventType = "STEP_FAILED"
	FlowExecutionEventTypeStepSucceeded              FlowExecutionEventType = "STEP_SUCCEEDED"
	FlowExecutionEventTypeActivityScheduled          FlowExecutionEventType = "ACTIVITY_SCHEDULED"
	FlowExecutionEventTypeActivityStarted            FlowExecutionEventType = "ACTIVITY_STARTED"
	FlowExecutionEventTypeActivityFailed             FlowExecutionEventType = "ACTIVITY_FAILED"
	FlowExecutionEventTypeActivitySucceeded          FlowExecutionEventType = "ACTIVITY_SUCCEEDED"
	FlowExecutionEventTypeStartFlowExecutionTask     FlowExecutionEventType = "START_FLOW_EXECUTION_TASK"
	FlowExecutionEventTypeScheduleNextReadyStepsTask FlowExecutionEventType = "SCHEDULE_NEXT_READY_STEPS_TASK"
	FlowExecutionEventTypeThingActionTask            FlowExecutionEventType = "THING_ACTION_TASK"
	FlowExecutionEventTypeThingActionTaskFailed      FlowExecutionEventType = "THING_ACTION_TASK_FAILED"
	FlowExecutionEventTypeThingActionTaskSucceeded   FlowExecutionEventType = "THING_ACTION_TASK_SUCCEEDED"
	FlowExecutionEventTypeAcknowledgeTaskMessage     FlowExecutionEventType = "ACKNOWLEDGE_TASK_MESSAGE"
)

Enum values for FlowExecutionEventType

func (FlowExecutionEventType) MarshalValue 

func (enum FlowExecutionEventType) MarshalValue() (string, error)

func (FlowExecutionEventType) MarshalValueBuf 

func (enum FlowExecutionEventType) MarshalValueBuf(b []byte) ([]byte, error)

type FlowExecutionMessage 

type FlowExecutionMessage struct {

	// The type of flow event .
	EventType FlowExecutionEventType `locationName:"eventType" type:"string" enum:"true"`

	// The unique identifier of the message.
	MessageId *string `locationName:"messageId" type:"string"`

	// A string containing information about the flow event.
	Payload *string `locationName:"payload" type:"string"`

	// The date and time when the message was last updated.
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp"`
	// contains filtered or unexported fields
}

An object that contains information about a flow event.

func (FlowExecutionMessage) String 

func (s FlowExecutionMessage) String() string

String returns the string representation

type FlowExecutionStatus 

type FlowExecutionStatus string
const (
	FlowExecutionStatusRunning   FlowExecutionStatus = "RUNNING"
	FlowExecutionStatusAborted   FlowExecutionStatus = "ABORTED"
	FlowExecutionStatusSucceeded FlowExecutionStatus = "SUCCEEDED"
	FlowExecutionStatusFailed    FlowExecutionStatus = "FAILED"
)

Enum values for FlowExecutionStatus

func (FlowExecutionStatus) MarshalValue 

func (enum FlowExecutionStatus) MarshalValue() (string, error)

func (FlowExecutionStatus) MarshalValueBuf 

func (enum FlowExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type FlowExecutionSummary 

type FlowExecutionSummary struct {

	// The date and time when the flow execution summary was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the flow execution.
	FlowExecutionId *string `locationName:"flowExecutionId" type:"string"`

	// The ID of the flow.
	FlowTemplateId *string `locationName:"flowTemplateId" type:"string"`

	// The current status of the flow execution.
	Status FlowExecutionStatus `locationName:"status" type:"string" enum:"true"`

	// The ID of the system instance that contains the flow.
	SystemInstanceId *string `locationName:"systemInstanceId" type:"string"`

	// The date and time when the flow execution summary was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

An object that contains summary information about a flow execution.

func (FlowExecutionSummary) String 

func (s FlowExecutionSummary) String() string

String returns the string representation

type FlowTemplateDescription 

type FlowTemplateDescription struct {

	// A workflow's definition document.
	Definition *DefinitionDocument `locationName:"definition" type:"structure"`

	// An object that contains summary information about a workflow.
	Summary *FlowTemplateSummary `locationName:"summary" type:"structure"`

	// The version of the user's namespace against which the workflow was validated.
	// Use this value in your system instance.
	ValidatedNamespaceVersion *int64 `locationName:"validatedNamespaceVersion" type:"long"`
	// contains filtered or unexported fields
}

An object that contains a workflow's definition and summary information.

func (FlowTemplateDescription) String 

func (s FlowTemplateDescription) String() string

String returns the string representation

type FlowTemplateFilter 

type FlowTemplateFilter struct {

	// The name of the search filter field.
	//
	// Name is a required field
	Name FlowTemplateFilterName `locationName:"name" type:"string" required:"true" enum:"true"`

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	//
	// Value is a required field
	Value []string `locationName:"value" type:"list" required:"true"`
	// contains filtered or unexported fields
}

An object that filters a workflow search.

func (FlowTemplateFilter) String 

func (s FlowTemplateFilter) String() string

String returns the string representation

func (*FlowTemplateFilter) Validate 

func (s *FlowTemplateFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FlowTemplateFilterName 

type FlowTemplateFilterName string
const (
	FlowTemplateFilterNameDeviceModelId FlowTemplateFilterName = "DEVICE_MODEL_ID"
)

Enum values for FlowTemplateFilterName

func (FlowTemplateFilterName) MarshalValue 

func (enum FlowTemplateFilterName) MarshalValue() (string, error)

func (FlowTemplateFilterName) MarshalValueBuf 

func (enum FlowTemplateFilterName) MarshalValueBuf(b []byte) ([]byte, error)

type FlowTemplateSummary 

type FlowTemplateSummary struct {

	// The ARN of the workflow.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the workflow was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the workflow.
	Id *string `locationName:"id" type:"string"`

	// The revision number of the workflow.
	RevisionNumber *int64 `locationName:"revisionNumber" type:"long"`
	// contains filtered or unexported fields
}

An object that contains summary information about a workflow.

func (FlowTemplateSummary) String 

func (s FlowTemplateSummary) String() string

String returns the string representation

type GetEntitiesInput 

type GetEntitiesInput struct {

	// An array of entity IDs.
	//
	// The IDs should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
	//
	// Ids is a required field
	Ids []string `locationName:"ids" type:"list" required:"true"`

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`
	// contains filtered or unexported fields
}

func (GetEntitiesInput) String 

func (s GetEntitiesInput) String() string

String returns the string representation

func (*GetEntitiesInput) Validate 

func (s *GetEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEntitiesOutput 

type GetEntitiesOutput struct {

	// An array of descriptions for the specified entities.
	Descriptions []EntityDescription `locationName:"descriptions" type:"list"`
	// contains filtered or unexported fields
}

func (GetEntitiesOutput) String 

func (s GetEntitiesOutput) String() string

String returns the string representation

type GetEntitiesRequest 

type GetEntitiesRequest struct {
	*aws.Request
	Input *GetEntitiesInput
	Copy  func(*GetEntitiesInput) GetEntitiesRequest
}

GetEntitiesRequest is the request type for the GetEntities API operation.

func (GetEntitiesRequest) Send 

func (r GetEntitiesRequest) Send(ctx context.Context) (*GetEntitiesResponse, error)

Send marshals and sends the GetEntities API request.

type GetEntitiesResponse 

type GetEntitiesResponse struct {
	*GetEntitiesOutput
	// contains filtered or unexported fields
}

GetEntitiesResponse is the response type for the GetEntities API operation.

func (*GetEntitiesResponse) SDKResponseMetdata 

func (r *GetEntitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetEntities request.

type GetFlowTemplateInput 

type GetFlowTemplateInput struct {

	// The ID of the workflow.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The number of the workflow revision to retrieve.
	RevisionNumber *int64 `locationName:"revisionNumber" type:"long"`
	// contains filtered or unexported fields
}

func (GetFlowTemplateInput) String 

func (s GetFlowTemplateInput) String() string

String returns the string representation

func (*GetFlowTemplateInput) Validate 

func (s *GetFlowTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFlowTemplateOutput 

type GetFlowTemplateOutput struct {

	// The object that describes the specified workflow.
	Description *FlowTemplateDescription `locationName:"description" type:"structure"`
	// contains filtered or unexported fields
}

func (GetFlowTemplateOutput) String 

func (s GetFlowTemplateOutput) String() string

String returns the string representation

type GetFlowTemplateRequest 

type GetFlowTemplateRequest struct {
	*aws.Request
	Input *GetFlowTemplateInput
	Copy  func(*GetFlowTemplateInput) GetFlowTemplateRequest
}

GetFlowTemplateRequest is the request type for the GetFlowTemplate API operation.

func (GetFlowTemplateRequest) Send 

func (r GetFlowTemplateRequest) Send(ctx context.Context) (*GetFlowTemplateResponse, error)

Send marshals and sends the GetFlowTemplate API request.

type GetFlowTemplateResponse 

type GetFlowTemplateResponse struct {
	*GetFlowTemplateOutput
	// contains filtered or unexported fields
}

GetFlowTemplateResponse is the response type for the GetFlowTemplate API operation.

func (*GetFlowTemplateResponse) SDKResponseMetdata 

func (r *GetFlowTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFlowTemplate request.

type GetFlowTemplateRevisionsInput 

type GetFlowTemplateRevisionsInput struct {

	// The ID of the workflow.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetFlowTemplateRevisionsInput) String 

func (s GetFlowTemplateRevisionsInput) String() string

String returns the string representation

func (*GetFlowTemplateRevisionsInput) Validate 

func (s *GetFlowTemplateRevisionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFlowTemplateRevisionsOutput 

type GetFlowTemplateRevisionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that provide summary data about each revision.
	Summaries []FlowTemplateSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (GetFlowTemplateRevisionsOutput) String 

func (s GetFlowTemplateRevisionsOutput) String() string

String returns the string representation

type GetFlowTemplateRevisionsPaginator 

type GetFlowTemplateRevisionsPaginator struct {
	aws.Pager
}

GetFlowTemplateRevisionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetFlowTemplateRevisionsPaginator 

func NewGetFlowTemplateRevisionsPaginator(req GetFlowTemplateRevisionsRequest) GetFlowTemplateRevisionsPaginator

NewGetFlowTemplateRevisionsRequestPaginator returns a paginator for GetFlowTemplateRevisions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetFlowTemplateRevisionsRequest(input)
p := iotthingsgraph.NewGetFlowTemplateRevisionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetFlowTemplateRevisionsPaginator) CurrentPage 

func (p *GetFlowTemplateRevisionsPaginator) CurrentPage() *GetFlowTemplateRevisionsOutput

type GetFlowTemplateRevisionsRequest 

type GetFlowTemplateRevisionsRequest struct {
	*aws.Request
	Input *GetFlowTemplateRevisionsInput
	Copy  func(*GetFlowTemplateRevisionsInput) GetFlowTemplateRevisionsRequest
}

GetFlowTemplateRevisionsRequest is the request type for the GetFlowTemplateRevisions API operation.

func (GetFlowTemplateRevisionsRequest) Send 

func (r GetFlowTemplateRevisionsRequest) Send(ctx context.Context) (*GetFlowTemplateRevisionsResponse, error)

Send marshals and sends the GetFlowTemplateRevisions API request.

type GetFlowTemplateRevisionsResponse 

type GetFlowTemplateRevisionsResponse struct {
	*GetFlowTemplateRevisionsOutput
	// contains filtered or unexported fields
}

GetFlowTemplateRevisionsResponse is the response type for the GetFlowTemplateRevisions API operation.

func (*GetFlowTemplateRevisionsResponse) SDKResponseMetdata 

func (r *GetFlowTemplateRevisionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetFlowTemplateRevisions request.

type GetNamespaceDeletionStatusInput 

type GetNamespaceDeletionStatusInput struct {
	// contains filtered or unexported fields
}

func (GetNamespaceDeletionStatusInput) String 

func (s GetNamespaceDeletionStatusInput) String() string

String returns the string representation

type GetNamespaceDeletionStatusOutput 

type GetNamespaceDeletionStatusOutput struct {

	// An error code returned by the namespace deletion task.
	ErrorCode NamespaceDeletionStatusErrorCodes `locationName:"errorCode" type:"string" enum:"true"`

	// An error code returned by the namespace deletion task.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The ARN of the namespace that is being deleted.
	NamespaceArn *string `locationName:"namespaceArn" type:"string"`

	// The name of the namespace that is being deleted.
	NamespaceName *string `locationName:"namespaceName" type:"string"`

	// The status of the deletion request.
	Status NamespaceDeletionStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetNamespaceDeletionStatusOutput) String 

func (s GetNamespaceDeletionStatusOutput) String() string

String returns the string representation

type GetNamespaceDeletionStatusRequest 

type GetNamespaceDeletionStatusRequest struct {
	*aws.Request
	Input *GetNamespaceDeletionStatusInput
	Copy  func(*GetNamespaceDeletionStatusInput) GetNamespaceDeletionStatusRequest
}

GetNamespaceDeletionStatusRequest is the request type for the GetNamespaceDeletionStatus API operation.

func (GetNamespaceDeletionStatusRequest) Send 

func (r GetNamespaceDeletionStatusRequest) Send(ctx context.Context) (*GetNamespaceDeletionStatusResponse, error)

Send marshals and sends the GetNamespaceDeletionStatus API request.

type GetNamespaceDeletionStatusResponse 

type GetNamespaceDeletionStatusResponse struct {
	*GetNamespaceDeletionStatusOutput
	// contains filtered or unexported fields
}

GetNamespaceDeletionStatusResponse is the response type for the GetNamespaceDeletionStatus API operation.

func (*GetNamespaceDeletionStatusResponse) SDKResponseMetdata 

func (r *GetNamespaceDeletionStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetNamespaceDeletionStatus request.

type GetSystemInstanceInput 

type GetSystemInstanceInput struct {

	// The ID of the system deployment instance. This value is returned by CreateSystemInstance.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSystemInstanceInput) String 

func (s GetSystemInstanceInput) String() string

String returns the string representation

func (*GetSystemInstanceInput) Validate 

func (s *GetSystemInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSystemInstanceOutput 

type GetSystemInstanceOutput struct {

	// An object that describes the system instance.
	Description *SystemInstanceDescription `locationName:"description" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSystemInstanceOutput) String 

func (s GetSystemInstanceOutput) String() string

String returns the string representation

type GetSystemInstanceRequest 

type GetSystemInstanceRequest struct {
	*aws.Request
	Input *GetSystemInstanceInput
	Copy  func(*GetSystemInstanceInput) GetSystemInstanceRequest
}

GetSystemInstanceRequest is the request type for the GetSystemInstance API operation.

func (GetSystemInstanceRequest) Send 

func (r GetSystemInstanceRequest) Send(ctx context.Context) (*GetSystemInstanceResponse, error)

Send marshals and sends the GetSystemInstance API request.

type GetSystemInstanceResponse 

type GetSystemInstanceResponse struct {
	*GetSystemInstanceOutput
	// contains filtered or unexported fields
}

GetSystemInstanceResponse is the response type for the GetSystemInstance API operation.

func (*GetSystemInstanceResponse) SDKResponseMetdata 

func (r *GetSystemInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSystemInstance request.

type GetSystemTemplateInput 

type GetSystemTemplateInput struct {

	// The ID of the system to get. This ID must be in the user's namespace.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The number that specifies the revision of the system to get.
	RevisionNumber *int64 `locationName:"revisionNumber" type:"long"`
	// contains filtered or unexported fields
}

func (GetSystemTemplateInput) String 

func (s GetSystemTemplateInput) String() string

String returns the string representation

func (*GetSystemTemplateInput) Validate 

func (s *GetSystemTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSystemTemplateOutput 

type GetSystemTemplateOutput struct {

	// An object that contains summary data about the system.
	Description *SystemTemplateDescription `locationName:"description" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSystemTemplateOutput) String 

func (s GetSystemTemplateOutput) String() string

String returns the string representation

type GetSystemTemplateRequest 

type GetSystemTemplateRequest struct {
	*aws.Request
	Input *GetSystemTemplateInput
	Copy  func(*GetSystemTemplateInput) GetSystemTemplateRequest
}

GetSystemTemplateRequest is the request type for the GetSystemTemplate API operation.

func (GetSystemTemplateRequest) Send 

func (r GetSystemTemplateRequest) Send(ctx context.Context) (*GetSystemTemplateResponse, error)

Send marshals and sends the GetSystemTemplate API request.

type GetSystemTemplateResponse 

type GetSystemTemplateResponse struct {
	*GetSystemTemplateOutput
	// contains filtered or unexported fields
}

GetSystemTemplateResponse is the response type for the GetSystemTemplate API operation.

func (*GetSystemTemplateResponse) SDKResponseMetdata 

func (r *GetSystemTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSystemTemplate request.

type GetSystemTemplateRevisionsInput 

type GetSystemTemplateRevisionsInput struct {

	// The ID of the system template.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetSystemTemplateRevisionsInput) String 

func (s GetSystemTemplateRevisionsInput) String() string

String returns the string representation

func (*GetSystemTemplateRevisionsInput) Validate 

func (s *GetSystemTemplateRevisionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSystemTemplateRevisionsOutput 

type GetSystemTemplateRevisionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that contain summary data about the system template revisions.
	Summaries []SystemTemplateSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (GetSystemTemplateRevisionsOutput) String 

func (s GetSystemTemplateRevisionsOutput) String() string

String returns the string representation

type GetSystemTemplateRevisionsPaginator 

type GetSystemTemplateRevisionsPaginator struct {
	aws.Pager
}

GetSystemTemplateRevisionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetSystemTemplateRevisionsPaginator 

func NewGetSystemTemplateRevisionsPaginator(req GetSystemTemplateRevisionsRequest) GetSystemTemplateRevisionsPaginator

NewGetSystemTemplateRevisionsRequestPaginator returns a paginator for GetSystemTemplateRevisions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetSystemTemplateRevisionsRequest(input)
p := iotthingsgraph.NewGetSystemTemplateRevisionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetSystemTemplateRevisionsPaginator) CurrentPage 

func (p *GetSystemTemplateRevisionsPaginator) CurrentPage() *GetSystemTemplateRevisionsOutput

type GetSystemTemplateRevisionsRequest 

type GetSystemTemplateRevisionsRequest struct {
	*aws.Request
	Input *GetSystemTemplateRevisionsInput
	Copy  func(*GetSystemTemplateRevisionsInput) GetSystemTemplateRevisionsRequest
}

GetSystemTemplateRevisionsRequest is the request type for the GetSystemTemplateRevisions API operation.

func (GetSystemTemplateRevisionsRequest) Send 

func (r GetSystemTemplateRevisionsRequest) Send(ctx context.Context) (*GetSystemTemplateRevisionsResponse, error)

Send marshals and sends the GetSystemTemplateRevisions API request.

type GetSystemTemplateRevisionsResponse 

type GetSystemTemplateRevisionsResponse struct {
	*GetSystemTemplateRevisionsOutput
	// contains filtered or unexported fields
}

GetSystemTemplateRevisionsResponse is the response type for the GetSystemTemplateRevisions API operation.

func (*GetSystemTemplateRevisionsResponse) SDKResponseMetdata 

func (r *GetSystemTemplateRevisionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSystemTemplateRevisions request.

type GetUploadStatusInput 

type GetUploadStatusInput struct {

	// The ID of the upload. This value is returned by the UploadEntityDefinitions
	// action.
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetUploadStatusInput) String 

func (s GetUploadStatusInput) String() string

String returns the string representation

func (*GetUploadStatusInput) Validate 

func (s *GetUploadStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetUploadStatusOutput 

type GetUploadStatusOutput struct {

	// The date at which the upload was created.
	//
	// CreatedDate is a required field
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" required:"true"`

	// The reason for an upload failure.
	FailureReason []string `locationName:"failureReason" type:"list"`

	// The ARN of the upload.
	NamespaceArn *string `locationName:"namespaceArn" type:"string"`

	// The name of the upload's namespace.
	NamespaceName *string `locationName:"namespaceName" type:"string"`

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`

	// The ID of the upload.
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`

	// The status of the upload. The initial status is IN_PROGRESS. The response
	// show all validation failures if the upload fails.
	//
	// UploadStatus is a required field
	UploadStatus UploadStatus `locationName:"uploadStatus" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (GetUploadStatusOutput) String 

func (s GetUploadStatusOutput) String() string

String returns the string representation

type GetUploadStatusRequest 

type GetUploadStatusRequest struct {
	*aws.Request
	Input *GetUploadStatusInput
	Copy  func(*GetUploadStatusInput) GetUploadStatusRequest
}

GetUploadStatusRequest is the request type for the GetUploadStatus API operation.

func (GetUploadStatusRequest) Send 

func (r GetUploadStatusRequest) Send(ctx context.Context) (*GetUploadStatusResponse, error)

Send marshals and sends the GetUploadStatus API request.

type GetUploadStatusResponse 

type GetUploadStatusResponse struct {
	*GetUploadStatusOutput
	// contains filtered or unexported fields
}

GetUploadStatusResponse is the response type for the GetUploadStatus API operation.

func (*GetUploadStatusResponse) SDKResponseMetdata 

func (r *GetUploadStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetUploadStatus request.

type ListFlowExecutionMessagesInput 

type ListFlowExecutionMessagesInput struct {

	// The ID of the flow execution.
	//
	// FlowExecutionId is a required field
	FlowExecutionId *string `locationName:"flowExecutionId" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowExecutionMessagesInput) String 

func (s ListFlowExecutionMessagesInput) String() string

String returns the string representation

func (*ListFlowExecutionMessagesInput) Validate 

func (s *ListFlowExecutionMessagesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFlowExecutionMessagesOutput 

type ListFlowExecutionMessagesOutput struct {

	// A list of objects that contain information about events in the specified
	// flow execution.
	Messages []FlowExecutionMessage `locationName:"messages" type:"list"`

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowExecutionMessagesOutput) String 

func (s ListFlowExecutionMessagesOutput) String() string

String returns the string representation

type ListFlowExecutionMessagesPaginator 

type ListFlowExecutionMessagesPaginator struct {
	aws.Pager
}

ListFlowExecutionMessagesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListFlowExecutionMessagesPaginator 

func NewListFlowExecutionMessagesPaginator(req ListFlowExecutionMessagesRequest) ListFlowExecutionMessagesPaginator

NewListFlowExecutionMessagesRequestPaginator returns a paginator for ListFlowExecutionMessages. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListFlowExecutionMessagesRequest(input)
p := iotthingsgraph.NewListFlowExecutionMessagesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListFlowExecutionMessagesPaginator) CurrentPage 

func (p *ListFlowExecutionMessagesPaginator) CurrentPage() *ListFlowExecutionMessagesOutput

type ListFlowExecutionMessagesRequest 

type ListFlowExecutionMessagesRequest struct {
	*aws.Request
	Input *ListFlowExecutionMessagesInput
	Copy  func(*ListFlowExecutionMessagesInput) ListFlowExecutionMessagesRequest
}

ListFlowExecutionMessagesRequest is the request type for the ListFlowExecutionMessages API operation.

func (ListFlowExecutionMessagesRequest) Send 

func (r ListFlowExecutionMessagesRequest) Send(ctx context.Context) (*ListFlowExecutionMessagesResponse, error)

Send marshals and sends the ListFlowExecutionMessages API request.

type ListFlowExecutionMessagesResponse 

type ListFlowExecutionMessagesResponse struct {
	*ListFlowExecutionMessagesOutput
	// contains filtered or unexported fields
}

ListFlowExecutionMessagesResponse is the response type for the ListFlowExecutionMessages API operation.

func (*ListFlowExecutionMessagesResponse) SDKResponseMetdata 

func (r *ListFlowExecutionMessagesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListFlowExecutionMessages request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The maximum number of tags to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token that specifies the next page of results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the resource whose tags are to be returned.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The token that specifies the next page of results to return.
	NextToken *string `locationName:"nextToken" type:"string"`

	// List of tags returned by the ListTagsForResource operation.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := iotthingsgraph.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type MetricsConfiguration 

type MetricsConfiguration struct {

	// A Boolean that specifies whether cloud metrics are collected.
	CloudMetricEnabled *bool `locationName:"cloudMetricEnabled" type:"boolean"`

	// The ARN of the role that is used to collect cloud metrics.
	MetricRuleRoleArn *string `locationName:"metricRuleRoleArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

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

func (MetricsConfiguration) String 

func (s MetricsConfiguration) String() string

String returns the string representation

func (*MetricsConfiguration) Validate 

func (s *MetricsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NamespaceDeletionStatus 

type NamespaceDeletionStatus string
const (
	NamespaceDeletionStatusInProgress NamespaceDeletionStatus = "IN_PROGRESS"
	NamespaceDeletionStatusSucceeded  NamespaceDeletionStatus = "SUCCEEDED"
	NamespaceDeletionStatusFailed     NamespaceDeletionStatus = "FAILED"
)

Enum values for NamespaceDeletionStatus

func (NamespaceDeletionStatus) MarshalValue 

func (enum NamespaceDeletionStatus) MarshalValue() (string, error)

func (NamespaceDeletionStatus) MarshalValueBuf 

func (enum NamespaceDeletionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type NamespaceDeletionStatusErrorCodes 

type NamespaceDeletionStatusErrorCodes string
const (
	NamespaceDeletionStatusErrorCodesValidationFailed NamespaceDeletionStatusErrorCodes = "VALIDATION_FAILED"
)

Enum values for NamespaceDeletionStatusErrorCodes

func (NamespaceDeletionStatusErrorCodes) MarshalValue 

func (enum NamespaceDeletionStatusErrorCodes) MarshalValue() (string, error)

func (NamespaceDeletionStatusErrorCodes) MarshalValueBuf 

func (enum NamespaceDeletionStatusErrorCodes) MarshalValueBuf(b []byte) ([]byte, error)

type SearchEntitiesInput 

type SearchEntitiesInput struct {

	// The entity types for which to search.
	//
	// EntityTypes is a required field
	EntityTypes []EntityType `locationName:"entityTypes" type:"list" required:"true"`

	// Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
	// SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
	// on entities that are used by the entity in the result set. For example, you
	// can filter on the ID of a property that is used in a state.
	//
	// Multiple filters function as OR criteria in the query. Multiple values passed
	// inside the filter function as AND criteria.
	Filters []EntityFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchEntitiesInput) String 

func (s SearchEntitiesInput) String() string

String returns the string representation

func (*SearchEntitiesInput) Validate 

func (s *SearchEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchEntitiesOutput 

type SearchEntitiesOutput struct {

	// An array of descriptions for each entity returned in the search result.
	Descriptions []EntityDescription `locationName:"descriptions" type:"list"`

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchEntitiesOutput) String 

func (s SearchEntitiesOutput) String() string

String returns the string representation

type SearchEntitiesPaginator 

type SearchEntitiesPaginator struct {
	aws.Pager
}

SearchEntitiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchEntitiesPaginator 

func NewSearchEntitiesPaginator(req SearchEntitiesRequest) SearchEntitiesPaginator

NewSearchEntitiesRequestPaginator returns a paginator for SearchEntities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchEntitiesRequest(input)
p := iotthingsgraph.NewSearchEntitiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchEntitiesPaginator) CurrentPage 

func (p *SearchEntitiesPaginator) CurrentPage() *SearchEntitiesOutput

type SearchEntitiesRequest 

type SearchEntitiesRequest struct {
	*aws.Request
	Input *SearchEntitiesInput
	Copy  func(*SearchEntitiesInput) SearchEntitiesRequest
}

SearchEntitiesRequest is the request type for the SearchEntities API operation.

func (SearchEntitiesRequest) Send 

func (r SearchEntitiesRequest) Send(ctx context.Context) (*SearchEntitiesResponse, error)

Send marshals and sends the SearchEntities API request.

type SearchEntitiesResponse 

type SearchEntitiesResponse struct {
	*SearchEntitiesOutput
	// contains filtered or unexported fields
}

SearchEntitiesResponse is the response type for the SearchEntities API operation.

func (*SearchEntitiesResponse) SDKResponseMetdata 

func (r *SearchEntitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchEntities request.

type SearchFlowExecutionsInput 

type SearchFlowExecutionsInput struct {

	// The date and time of the latest flow execution to return.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The ID of a flow execution.
	FlowExecutionId *string `locationName:"flowExecutionId" type:"string"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The date and time of the earliest flow execution to return.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// The ID of the system instance that contains the flow.
	//
	// SystemInstanceId is a required field
	SystemInstanceId *string `locationName:"systemInstanceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SearchFlowExecutionsInput) String 

func (s SearchFlowExecutionsInput) String() string

String returns the string representation

func (*SearchFlowExecutionsInput) Validate 

func (s *SearchFlowExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchFlowExecutionsOutput 

type SearchFlowExecutionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that contain summary information about each workflow
	// execution in the result set.
	Summaries []FlowExecutionSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (SearchFlowExecutionsOutput) String 

func (s SearchFlowExecutionsOutput) String() string

String returns the string representation

type SearchFlowExecutionsPaginator 

type SearchFlowExecutionsPaginator struct {
	aws.Pager
}

SearchFlowExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchFlowExecutionsPaginator 

func NewSearchFlowExecutionsPaginator(req SearchFlowExecutionsRequest) SearchFlowExecutionsPaginator

NewSearchFlowExecutionsRequestPaginator returns a paginator for SearchFlowExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchFlowExecutionsRequest(input)
p := iotthingsgraph.NewSearchFlowExecutionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchFlowExecutionsPaginator) CurrentPage 

func (p *SearchFlowExecutionsPaginator) CurrentPage() *SearchFlowExecutionsOutput

type SearchFlowExecutionsRequest 

type SearchFlowExecutionsRequest struct {
	*aws.Request
	Input *SearchFlowExecutionsInput
	Copy  func(*SearchFlowExecutionsInput) SearchFlowExecutionsRequest
}

SearchFlowExecutionsRequest is the request type for the SearchFlowExecutions API operation.

func (SearchFlowExecutionsRequest) Send 

func (r SearchFlowExecutionsRequest) Send(ctx context.Context) (*SearchFlowExecutionsResponse, error)

Send marshals and sends the SearchFlowExecutions API request.

type SearchFlowExecutionsResponse 

type SearchFlowExecutionsResponse struct {
	*SearchFlowExecutionsOutput
	// contains filtered or unexported fields
}

SearchFlowExecutionsResponse is the response type for the SearchFlowExecutions API operation.

func (*SearchFlowExecutionsResponse) SDKResponseMetdata 

func (r *SearchFlowExecutionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchFlowExecutions request.

type SearchFlowTemplatesInput 

type SearchFlowTemplatesInput struct {

	// An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.
	Filters []FlowTemplateFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchFlowTemplatesInput) String 

func (s SearchFlowTemplatesInput) String() string

String returns the string representation

func (*SearchFlowTemplatesInput) Validate 

func (s *SearchFlowTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchFlowTemplatesOutput 

type SearchFlowTemplatesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that contain summary information about each workflow
	// in the result set.
	Summaries []FlowTemplateSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (SearchFlowTemplatesOutput) String 

func (s SearchFlowTemplatesOutput) String() string

String returns the string representation

type SearchFlowTemplatesPaginator 

type SearchFlowTemplatesPaginator struct {
	aws.Pager
}

SearchFlowTemplatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchFlowTemplatesPaginator 

func NewSearchFlowTemplatesPaginator(req SearchFlowTemplatesRequest) SearchFlowTemplatesPaginator

NewSearchFlowTemplatesRequestPaginator returns a paginator for SearchFlowTemplates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchFlowTemplatesRequest(input)
p := iotthingsgraph.NewSearchFlowTemplatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchFlowTemplatesPaginator) CurrentPage 

func (p *SearchFlowTemplatesPaginator) CurrentPage() *SearchFlowTemplatesOutput

type SearchFlowTemplatesRequest 

type SearchFlowTemplatesRequest struct {
	*aws.Request
	Input *SearchFlowTemplatesInput
	Copy  func(*SearchFlowTemplatesInput) SearchFlowTemplatesRequest
}

SearchFlowTemplatesRequest is the request type for the SearchFlowTemplates API operation.

func (SearchFlowTemplatesRequest) Send 

func (r SearchFlowTemplatesRequest) Send(ctx context.Context) (*SearchFlowTemplatesResponse, error)

Send marshals and sends the SearchFlowTemplates API request.

type SearchFlowTemplatesResponse 

type SearchFlowTemplatesResponse struct {
	*SearchFlowTemplatesOutput
	// contains filtered or unexported fields
}

SearchFlowTemplatesResponse is the response type for the SearchFlowTemplates API operation.

func (*SearchFlowTemplatesResponse) SDKResponseMetdata 

func (r *SearchFlowTemplatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchFlowTemplates request.

type SearchSystemInstancesInput 

type SearchSystemInstancesInput struct {

	// Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID,
	// STATUS, and GREENGRASS_GROUP_NAME.
	//
	// Multiple filters function as OR criteria in the query. Multiple values passed
	// inside the filter function as AND criteria.
	Filters []SystemInstanceFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchSystemInstancesInput) String 

func (s SearchSystemInstancesInput) String() string

String returns the string representation

func (*SearchSystemInstancesInput) Validate 

func (s *SearchSystemInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchSystemInstancesOutput 

type SearchSystemInstancesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that contain summary data abour the system instances
	// in the result set.
	Summaries []SystemInstanceSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (SearchSystemInstancesOutput) String 

func (s SearchSystemInstancesOutput) String() string

String returns the string representation

type SearchSystemInstancesPaginator 

type SearchSystemInstancesPaginator struct {
	aws.Pager
}

SearchSystemInstancesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchSystemInstancesPaginator 

func NewSearchSystemInstancesPaginator(req SearchSystemInstancesRequest) SearchSystemInstancesPaginator

NewSearchSystemInstancesRequestPaginator returns a paginator for SearchSystemInstances. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchSystemInstancesRequest(input)
p := iotthingsgraph.NewSearchSystemInstancesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchSystemInstancesPaginator) CurrentPage 

func (p *SearchSystemInstancesPaginator) CurrentPage() *SearchSystemInstancesOutput

type SearchSystemInstancesRequest 

type SearchSystemInstancesRequest struct {
	*aws.Request
	Input *SearchSystemInstancesInput
	Copy  func(*SearchSystemInstancesInput) SearchSystemInstancesRequest
}

SearchSystemInstancesRequest is the request type for the SearchSystemInstances API operation.

func (SearchSystemInstancesRequest) Send 

func (r SearchSystemInstancesRequest) Send(ctx context.Context) (*SearchSystemInstancesResponse, error)

Send marshals and sends the SearchSystemInstances API request.

type SearchSystemInstancesResponse 

type SearchSystemInstancesResponse struct {
	*SearchSystemInstancesOutput
	// contains filtered or unexported fields
}

SearchSystemInstancesResponse is the response type for the SearchSystemInstances API operation.

func (*SearchSystemInstancesResponse) SDKResponseMetdata 

func (r *SearchSystemInstancesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchSystemInstances request.

type SearchSystemTemplatesInput 

type SearchSystemTemplatesInput struct {

	// An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.
	Filters []SystemTemplateFilter `locationName:"filters" type:"list"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchSystemTemplatesInput) String 

func (s SearchSystemTemplatesInput) String() string

String returns the string representation

func (*SearchSystemTemplatesInput) Validate 

func (s *SearchSystemTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchSystemTemplatesOutput 

type SearchSystemTemplatesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that contain summary information about each system deployment
	// in the result set.
	Summaries []SystemTemplateSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (SearchSystemTemplatesOutput) String 

func (s SearchSystemTemplatesOutput) String() string

String returns the string representation

type SearchSystemTemplatesPaginator 

type SearchSystemTemplatesPaginator struct {
	aws.Pager
}

SearchSystemTemplatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchSystemTemplatesPaginator 

func NewSearchSystemTemplatesPaginator(req SearchSystemTemplatesRequest) SearchSystemTemplatesPaginator

NewSearchSystemTemplatesRequestPaginator returns a paginator for SearchSystemTemplates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchSystemTemplatesRequest(input)
p := iotthingsgraph.NewSearchSystemTemplatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchSystemTemplatesPaginator) CurrentPage 

func (p *SearchSystemTemplatesPaginator) CurrentPage() *SearchSystemTemplatesOutput

type SearchSystemTemplatesRequest 

type SearchSystemTemplatesRequest struct {
	*aws.Request
	Input *SearchSystemTemplatesInput
	Copy  func(*SearchSystemTemplatesInput) SearchSystemTemplatesRequest
}

SearchSystemTemplatesRequest is the request type for the SearchSystemTemplates API operation.

func (SearchSystemTemplatesRequest) Send 

func (r SearchSystemTemplatesRequest) Send(ctx context.Context) (*SearchSystemTemplatesResponse, error)

Send marshals and sends the SearchSystemTemplates API request.

type SearchSystemTemplatesResponse 

type SearchSystemTemplatesResponse struct {
	*SearchSystemTemplatesOutput
	// contains filtered or unexported fields
}

SearchSystemTemplatesResponse is the response type for the SearchSystemTemplates API operation.

func (*SearchSystemTemplatesResponse) SDKResponseMetdata 

func (r *SearchSystemTemplatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchSystemTemplates request.

type SearchThingsInput 

type SearchThingsInput struct {

	// The ID of the entity to which the things are associated.
	//
	// The IDs should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
	//
	// EntityId is a required field
	EntityId *string `locationName:"entityId" type:"string" required:"true"`

	// The maximum number of results to return in the response.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64 `locationName:"namespaceVersion" type:"long"`

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (SearchThingsInput) String 

func (s SearchThingsInput) String() string

String returns the string representation

func (*SearchThingsInput) Validate 

func (s *SearchThingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SearchThingsOutput 

type SearchThingsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of things in the result set.
	Things []Thing `locationName:"things" type:"list"`
	// contains filtered or unexported fields
}

func (SearchThingsOutput) String 

func (s SearchThingsOutput) String() string

String returns the string representation

type SearchThingsPaginator 

type SearchThingsPaginator struct {
	aws.Pager
}

SearchThingsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewSearchThingsPaginator 

func NewSearchThingsPaginator(req SearchThingsRequest) SearchThingsPaginator

NewSearchThingsRequestPaginator returns a paginator for SearchThings. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.SearchThingsRequest(input)
p := iotthingsgraph.NewSearchThingsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*SearchThingsPaginator) CurrentPage 

func (p *SearchThingsPaginator) CurrentPage() *SearchThingsOutput

type SearchThingsRequest 

type SearchThingsRequest struct {
	*aws.Request
	Input *SearchThingsInput
	Copy  func(*SearchThingsInput) SearchThingsRequest
}

SearchThingsRequest is the request type for the SearchThings API operation.

func (SearchThingsRequest) Send 

func (r SearchThingsRequest) Send(ctx context.Context) (*SearchThingsResponse, error)

Send marshals and sends the SearchThings API request.

type SearchThingsResponse 

type SearchThingsResponse struct {
	*SearchThingsOutput
	// contains filtered or unexported fields
}

SearchThingsResponse is the response type for the SearchThings API operation.

func (*SearchThingsResponse) SDKResponseMetdata 

func (r *SearchThingsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SearchThings request.

type SystemInstanceDeploymentStatus 

type SystemInstanceDeploymentStatus string
const (
	SystemInstanceDeploymentStatusNotDeployed        SystemInstanceDeploymentStatus = "NOT_DEPLOYED"
	SystemInstanceDeploymentStatusBootstrap          SystemInstanceDeploymentStatus = "BOOTSTRAP"
	SystemInstanceDeploymentStatusDeployInProgress   SystemInstanceDeploymentStatus = "DEPLOY_IN_PROGRESS"
	SystemInstanceDeploymentStatusDeployedInTarget   SystemInstanceDeploymentStatus = "DEPLOYED_IN_TARGET"
	SystemInstanceDeploymentStatusUndeployInProgress SystemInstanceDeploymentStatus = "UNDEPLOY_IN_PROGRESS"
	SystemInstanceDeploymentStatusFailed             SystemInstanceDeploymentStatus = "FAILED"
	SystemInstanceDeploymentStatusPendingDelete      SystemInstanceDeploymentStatus = "PENDING_DELETE"
	SystemInstanceDeploymentStatusDeletedInTarget    SystemInstanceDeploymentStatus = "DELETED_IN_TARGET"
)

Enum values for SystemInstanceDeploymentStatus

func (SystemInstanceDeploymentStatus) MarshalValue 

func (enum SystemInstanceDeploymentStatus) MarshalValue() (string, error)

func (SystemInstanceDeploymentStatus) MarshalValueBuf 

func (enum SystemInstanceDeploymentStatus) MarshalValueBuf(b []byte) ([]byte, error)

type SystemInstanceDescription 

type SystemInstanceDescription struct {

	// A document that defines an entity.
	Definition *DefinitionDocument `locationName:"definition" type:"structure"`

	// The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph
	// assumes during flow execution in a cloud deployment. This role must have
	// read and write permissionss to AWS Lambda and AWS IoT and to any other AWS
	// services that the flow uses.
	FlowActionsRoleArn *string `locationName:"flowActionsRoleArn" min:"20" type:"string"`

	// An object that specifies whether cloud metrics are collected in a deployment
	// and, if so, what role is used to collect metrics.
	MetricsConfiguration *MetricsConfiguration `locationName:"metricsConfiguration" type:"structure"`

	// The Amazon Simple Storage Service bucket where information about a system
	// instance is stored.
	S3BucketName *string `locationName:"s3BucketName" type:"string"`

	// An object that contains summary information about a system instance.
	Summary *SystemInstanceSummary `locationName:"summary" type:"structure"`

	// A list of objects that contain all of the IDs and revision numbers of workflows
	// and systems that are used in a system instance.
	ValidatedDependencyRevisions []DependencyRevision `locationName:"validatedDependencyRevisions" type:"list"`

	// The version of the user's namespace against which the system instance was
	// validated.
	ValidatedNamespaceVersion *int64 `locationName:"validatedNamespaceVersion" type:"long"`
	// contains filtered or unexported fields
}

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

func (SystemInstanceDescription) String 

func (s SystemInstanceDescription) String() string

String returns the string representation

type SystemInstanceFilter 

type SystemInstanceFilter struct {

	// The name of the search filter field.
	Name SystemInstanceFilterName `locationName:"name" type:"string" enum:"true"`

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []string `locationName:"value" type:"list"`
	// contains filtered or unexported fields
}

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.

func (SystemInstanceFilter) String 

func (s SystemInstanceFilter) String() string

String returns the string representation

type SystemInstanceFilterName 

type SystemInstanceFilterName string
const (
	SystemInstanceFilterNameSystemTemplateId    SystemInstanceFilterName = "SYSTEM_TEMPLATE_ID"
	SystemInstanceFilterNameStatus              SystemInstanceFilterName = "STATUS"
	SystemInstanceFilterNameGreengrassGroupName SystemInstanceFilterName = "GREENGRASS_GROUP_NAME"
)

Enum values for SystemInstanceFilterName

func (SystemInstanceFilterName) MarshalValue 

func (enum SystemInstanceFilterName) MarshalValue() (string, error)

func (SystemInstanceFilterName) MarshalValueBuf 

func (enum SystemInstanceFilterName) MarshalValueBuf(b []byte) ([]byte, error)

type SystemInstanceSummary 

type SystemInstanceSummary struct {

	// The ARN of the system instance.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the system instance was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the Greengrass group where the system instance is deployed.
	GreengrassGroupId *string `locationName:"greengrassGroupId" type:"string"`

	// The ID of the Greengrass group where the system instance is deployed.
	GreengrassGroupName *string `locationName:"greengrassGroupName" type:"string"`

	// The version of the Greengrass group where the system instance is deployed.
	GreengrassGroupVersionId *string `locationName:"greengrassGroupVersionId" type:"string"`

	// The ID of the system instance.
	Id *string `locationName:"id" type:"string"`

	// The status of the system instance.
	Status SystemInstanceDeploymentStatus `locationName:"status" type:"string" enum:"true"`

	// The target of the system instance.
	Target DeploymentTarget `locationName:"target" type:"string" enum:"true"`

	// The date and time when the system instance was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

An object that contains summary information about a system instance.

func (SystemInstanceSummary) String 

func (s SystemInstanceSummary) String() string

String returns the string representation

type SystemTemplateDescription 

type SystemTemplateDescription struct {

	// The definition document of a system.
	Definition *DefinitionDocument `locationName:"definition" type:"structure"`

	// An object that contains summary information about a system.
	Summary *SystemTemplateSummary `locationName:"summary" type:"structure"`

	// The namespace version against which the system was validated. Use this value
	// in your system instance.
	ValidatedNamespaceVersion *int64 `locationName:"validatedNamespaceVersion" type:"long"`
	// contains filtered or unexported fields
}

An object that contains a system's definition document and summary information.

func (SystemTemplateDescription) String 

func (s SystemTemplateDescription) String() string

String returns the string representation

type SystemTemplateFilter 

type SystemTemplateFilter struct {

	// The name of the system search filter field.
	//
	// Name is a required field
	Name SystemTemplateFilterName `locationName:"name" type:"string" required:"true" enum:"true"`

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	//
	// Value is a required field
	Value []string `locationName:"value" type:"list" required:"true"`
	// contains filtered or unexported fields
}

An object that filters a system search.

func (SystemTemplateFilter) String 

func (s SystemTemplateFilter) String() string

String returns the string representation

func (*SystemTemplateFilter) Validate 

func (s *SystemTemplateFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SystemTemplateFilterName 

type SystemTemplateFilterName string
const (
	SystemTemplateFilterNameFlowTemplateId SystemTemplateFilterName = "FLOW_TEMPLATE_ID"
)

Enum values for SystemTemplateFilterName

func (SystemTemplateFilterName) MarshalValue 

func (enum SystemTemplateFilterName) MarshalValue() (string, error)

func (SystemTemplateFilterName) MarshalValueBuf 

func (enum SystemTemplateFilterName) MarshalValueBuf(b []byte) ([]byte, error)

type SystemTemplateSummary 

type SystemTemplateSummary struct {

	// The ARN of the system.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the system was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the system.
	Id *string `locationName:"id" type:"string"`

	// The revision number of the system.
	RevisionNumber *int64 `locationName:"revisionNumber" type:"long"`
	// contains filtered or unexported fields
}

An object that contains information about a system.

func (SystemTemplateSummary) String 

func (s SystemTemplateSummary) String() string

String returns the string representation

type Tag 

type Tag struct {

	// The required name of the tag. The string value can be from 1 to 128 Unicode
	// characters in length.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The optional value of the tag. The string value can be from 1 to 256 Unicode
	// characters in length.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags are returned.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of tags to add to the resource.>
	//
	// Tags is a required field
	Tags []Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Thing 

type Thing struct {

	// The ARN of the thing.
	ThingArn *string `locationName:"thingArn" type:"string"`

	// The name of the thing.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An AWS IoT thing.

func (Thing) String 

func (s Thing) String() string

String returns the string representation

type UndeploySystemInstanceInput 

type UndeploySystemInstanceInput struct {

	// The ID of the system instance to remove from its target.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

func (UndeploySystemInstanceInput) String 

func (s UndeploySystemInstanceInput) String() string

String returns the string representation

type UndeploySystemInstanceOutput 

type UndeploySystemInstanceOutput struct {

	// An object that contains summary information about the system instance that
	// was removed from its target.
	Summary *SystemInstanceSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (UndeploySystemInstanceOutput) String 

func (s UndeploySystemInstanceOutput) String() string

String returns the string representation

type UndeploySystemInstanceRequest 

type UndeploySystemInstanceRequest struct {
	*aws.Request
	Input *UndeploySystemInstanceInput
	Copy  func(*UndeploySystemInstanceInput) UndeploySystemInstanceRequest
}

UndeploySystemInstanceRequest is the request type for the UndeploySystemInstance API operation.

func (UndeploySystemInstanceRequest) Send 

func (r UndeploySystemInstanceRequest) Send(ctx context.Context) (*UndeploySystemInstanceResponse, error)

Send marshals and sends the UndeploySystemInstance API request.

type UndeploySystemInstanceResponse 

type UndeploySystemInstanceResponse struct {
	*UndeploySystemInstanceOutput
	// contains filtered or unexported fields
}

UndeploySystemInstanceResponse is the response type for the UndeploySystemInstance API operation.

func (*UndeploySystemInstanceResponse) SDKResponseMetdata 

func (r *UndeploySystemInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UndeploySystemInstance request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of tag key names to remove from the resource. You don't specify the
	// value. Both the key and its associated value are removed.
	//
	// This parameter to the API requires a JSON text string argument. For information
	// on how to format a JSON parameter for the various command line tool environments,
	// see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json)
	// in the AWS CLI User Guide.
	//
	// TagKeys is a required field
	TagKeys []string `locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateFlowTemplateInput 

type UpdateFlowTemplateInput struct {

	// The version of the user's namespace.
	//
	// If no value is specified, the latest version is used by default. Use the
	// GetFlowTemplateRevisions if you want to find earlier revisions of the flow
	// to update.
	CompatibleNamespaceVersion *int64 `locationName:"compatibleNamespaceVersion" type:"long"`

	// The DefinitionDocument that contains the updated workflow definition.
	//
	// Definition is a required field
	Definition *DefinitionDocument `locationName:"definition" type:"structure" required:"true"`

	// The ID of the workflow to be updated.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFlowTemplateInput) String 

func (s UpdateFlowTemplateInput) String() string

String returns the string representation

func (*UpdateFlowTemplateInput) Validate 

func (s *UpdateFlowTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFlowTemplateOutput 

type UpdateFlowTemplateOutput struct {

	// An object containing summary information about the updated workflow.
	Summary *FlowTemplateSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateFlowTemplateOutput) String 

func (s UpdateFlowTemplateOutput) String() string

String returns the string representation

type UpdateFlowTemplateRequest 

type UpdateFlowTemplateRequest struct {
	*aws.Request
	Input *UpdateFlowTemplateInput
	Copy  func(*UpdateFlowTemplateInput) UpdateFlowTemplateRequest
}

UpdateFlowTemplateRequest is the request type for the UpdateFlowTemplate API operation.

func (UpdateFlowTemplateRequest) Send 

func (r UpdateFlowTemplateRequest) Send(ctx context.Context) (*UpdateFlowTemplateResponse, error)

Send marshals and sends the UpdateFlowTemplate API request.

type UpdateFlowTemplateResponse 

type UpdateFlowTemplateResponse struct {
	*UpdateFlowTemplateOutput
	// contains filtered or unexported fields
}

UpdateFlowTemplateResponse is the response type for the UpdateFlowTemplate API operation.

func (*UpdateFlowTemplateResponse) SDKResponseMetdata 

func (r *UpdateFlowTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFlowTemplate request.

type UpdateSystemTemplateInput 

type UpdateSystemTemplateInput struct {

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	//
	// If no value is specified, the latest version is used by default.
	CompatibleNamespaceVersion *int64 `locationName:"compatibleNamespaceVersion" type:"long"`

	// The DefinitionDocument that contains the updated system definition.
	//
	// Definition is a required field
	Definition *DefinitionDocument `locationName:"definition" type:"structure" required:"true"`

	// The ID of the system to be updated.
	//
	// The ID should be in the following format.
	//
	// urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSystemTemplateInput) String 

func (s UpdateSystemTemplateInput) String() string

String returns the string representation

func (*UpdateSystemTemplateInput) Validate 

func (s *UpdateSystemTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSystemTemplateOutput 

type UpdateSystemTemplateOutput struct {

	// An object containing summary information about the updated system.
	Summary *SystemTemplateSummary `locationName:"summary" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSystemTemplateOutput) String 

func (s UpdateSystemTemplateOutput) String() string

String returns the string representation

type UpdateSystemTemplateRequest 

type UpdateSystemTemplateRequest struct {
	*aws.Request
	Input *UpdateSystemTemplateInput
	Copy  func(*UpdateSystemTemplateInput) UpdateSystemTemplateRequest
}

UpdateSystemTemplateRequest is the request type for the UpdateSystemTemplate API operation.

func (UpdateSystemTemplateRequest) Send 

func (r UpdateSystemTemplateRequest) Send(ctx context.Context) (*UpdateSystemTemplateResponse, error)

Send marshals and sends the UpdateSystemTemplate API request.

type UpdateSystemTemplateResponse 

type UpdateSystemTemplateResponse struct {
	*UpdateSystemTemplateOutput
	// contains filtered or unexported fields
}

UpdateSystemTemplateResponse is the response type for the UpdateSystemTemplate API operation.

func (*UpdateSystemTemplateResponse) SDKResponseMetdata 

func (r *UpdateSystemTemplateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSystemTemplate request.

type UploadEntityDefinitionsInput 

type UploadEntityDefinitionsInput struct {

	// A Boolean that specifies whether to deprecate all entities in the latest
	// version before uploading the new DefinitionDocument. If set to true, the
	// upload will create a new namespace version.
	DeprecateExistingEntities *bool `locationName:"deprecateExistingEntities" type:"boolean"`

	// The DefinitionDocument that defines the updated entities.
	Document *DefinitionDocument `locationName:"document" type:"structure"`

	// A Boolean that specifies whether to synchronize with the latest version of
	// the public namespace. If set to true, the upload will create a new namespace
	// version.
	SyncWithPublicNamespace *bool `locationName:"syncWithPublicNamespace" type:"boolean"`
	// contains filtered or unexported fields
}

func (UploadEntityDefinitionsInput) String 

func (s UploadEntityDefinitionsInput) String() string

String returns the string representation

func (*UploadEntityDefinitionsInput) Validate 

func (s *UploadEntityDefinitionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UploadEntityDefinitionsOutput 

type UploadEntityDefinitionsOutput struct {

	// The ID that specifies the upload action. You can use this to track the status
	// of the upload.
	//
	// UploadId is a required field
	UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UploadEntityDefinitionsOutput) String 

func (s UploadEntityDefinitionsOutput) String() string

String returns the string representation

type UploadEntityDefinitionsRequest 

type UploadEntityDefinitionsRequest struct {
	*aws.Request
	Input *UploadEntityDefinitionsInput
	Copy  func(*UploadEntityDefinitionsInput) UploadEntityDefinitionsRequest
}

UploadEntityDefinitionsRequest is the request type for the UploadEntityDefinitions API operation.

func (UploadEntityDefinitionsRequest) Send 

func (r UploadEntityDefinitionsRequest) Send(ctx context.Context) (*UploadEntityDefinitionsResponse, error)

Send marshals and sends the UploadEntityDefinitions API request.

type UploadEntityDefinitionsResponse 

type UploadEntityDefinitionsResponse struct {
	*UploadEntityDefinitionsOutput
	// contains filtered or unexported fields
}

UploadEntityDefinitionsResponse is the response type for the UploadEntityDefinitions API operation.

func (*UploadEntityDefinitionsResponse) SDKResponseMetdata 

func (r *UploadEntityDefinitionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UploadEntityDefinitions request.

type UploadStatus 

type UploadStatus string
const (
	UploadStatusInProgress UploadStatus = "IN_PROGRESS"
	UploadStatusSucceeded  UploadStatus = "SUCCEEDED"
	UploadStatusFailed     UploadStatus = "FAILED"
)

Enum values for UploadStatus

func (UploadStatus) MarshalValue 

func (enum UploadStatus) MarshalValue() (string, error)

func (UploadStatus) MarshalValueBuf 

func (enum UploadStatus) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package iotthingsgraphiface provides an interface to enable mocking the AWS IoT Things Graph service client for testing your code.
 Package iotthingsgraphiface provides an interface to enable mocking the AWS IoT Things Graph service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.