iotthingsgraph

package
v1.44.122 Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2022 License: Apache-2.0 Imports: 10 Imported by: 19

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

The AWS IoT Things Graph service is discontinued.

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 contact 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 IoTThingsGraph 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 (
	// DeploymentTargetGreengrass is a DeploymentTarget enum value
	DeploymentTargetGreengrass = "GREENGRASS"

	// DeploymentTargetCloud is a DeploymentTarget enum value
	DeploymentTargetCloud = "CLOUD"
)
View Source 
const (
	// EntityFilterNameName is a EntityFilterName enum value
	EntityFilterNameName = "NAME"

	// EntityFilterNameNamespace is a EntityFilterName enum value
	EntityFilterNameNamespace = "NAMESPACE"

	// EntityFilterNameSemanticTypePath is a EntityFilterName enum value
	EntityFilterNameSemanticTypePath = "SEMANTIC_TYPE_PATH"

	// EntityFilterNameReferencedEntityId is a EntityFilterName enum value
	EntityFilterNameReferencedEntityId = "REFERENCED_ENTITY_ID"
)
View Source 
const (
	// EntityTypeDevice is a EntityType enum value
	EntityTypeDevice = "DEVICE"

	// EntityTypeService is a EntityType enum value
	EntityTypeService = "SERVICE"

	// EntityTypeDeviceModel is a EntityType enum value
	EntityTypeDeviceModel = "DEVICE_MODEL"

	// EntityTypeCapability is a EntityType enum value
	EntityTypeCapability = "CAPABILITY"

	// EntityTypeState is a EntityType enum value
	EntityTypeState = "STATE"

	// EntityTypeAction is a EntityType enum value
	EntityTypeAction = "ACTION"

	// EntityTypeEvent is a EntityType enum value
	EntityTypeEvent = "EVENT"

	// EntityTypeProperty is a EntityType enum value
	EntityTypeProperty = "PROPERTY"

	// EntityTypeMapping is a EntityType enum value
	EntityTypeMapping = "MAPPING"

	// EntityTypeEnum is a EntityType enum value
	EntityTypeEnum = "ENUM"
)
View Source 
const (
	// FlowExecutionEventTypeExecutionStarted is a FlowExecutionEventType enum value
	FlowExecutionEventTypeExecutionStarted = "EXECUTION_STARTED"

	// FlowExecutionEventTypeExecutionFailed is a FlowExecutionEventType enum value
	FlowExecutionEventTypeExecutionFailed = "EXECUTION_FAILED"

	// FlowExecutionEventTypeExecutionAborted is a FlowExecutionEventType enum value
	FlowExecutionEventTypeExecutionAborted = "EXECUTION_ABORTED"

	// FlowExecutionEventTypeExecutionSucceeded is a FlowExecutionEventType enum value
	FlowExecutionEventTypeExecutionSucceeded = "EXECUTION_SUCCEEDED"

	// FlowExecutionEventTypeStepStarted is a FlowExecutionEventType enum value
	FlowExecutionEventTypeStepStarted = "STEP_STARTED"

	// FlowExecutionEventTypeStepFailed is a FlowExecutionEventType enum value
	FlowExecutionEventTypeStepFailed = "STEP_FAILED"

	// FlowExecutionEventTypeStepSucceeded is a FlowExecutionEventType enum value
	FlowExecutionEventTypeStepSucceeded = "STEP_SUCCEEDED"

	// FlowExecutionEventTypeActivityScheduled is a FlowExecutionEventType enum value
	FlowExecutionEventTypeActivityScheduled = "ACTIVITY_SCHEDULED"

	// FlowExecutionEventTypeActivityStarted is a FlowExecutionEventType enum value
	FlowExecutionEventTypeActivityStarted = "ACTIVITY_STARTED"

	// FlowExecutionEventTypeActivityFailed is a FlowExecutionEventType enum value
	FlowExecutionEventTypeActivityFailed = "ACTIVITY_FAILED"

	// FlowExecutionEventTypeActivitySucceeded is a FlowExecutionEventType enum value
	FlowExecutionEventTypeActivitySucceeded = "ACTIVITY_SUCCEEDED"

	// FlowExecutionEventTypeStartFlowExecutionTask is a FlowExecutionEventType enum value
	FlowExecutionEventTypeStartFlowExecutionTask = "START_FLOW_EXECUTION_TASK"

	// FlowExecutionEventTypeScheduleNextReadyStepsTask is a FlowExecutionEventType enum value
	FlowExecutionEventTypeScheduleNextReadyStepsTask = "SCHEDULE_NEXT_READY_STEPS_TASK"

	// FlowExecutionEventTypeThingActionTask is a FlowExecutionEventType enum value
	FlowExecutionEventTypeThingActionTask = "THING_ACTION_TASK"

	// FlowExecutionEventTypeThingActionTaskFailed is a FlowExecutionEventType enum value
	FlowExecutionEventTypeThingActionTaskFailed = "THING_ACTION_TASK_FAILED"

	// FlowExecutionEventTypeThingActionTaskSucceeded is a FlowExecutionEventType enum value
	FlowExecutionEventTypeThingActionTaskSucceeded = "THING_ACTION_TASK_SUCCEEDED"

	// FlowExecutionEventTypeAcknowledgeTaskMessage is a FlowExecutionEventType enum value
	FlowExecutionEventTypeAcknowledgeTaskMessage = "ACKNOWLEDGE_TASK_MESSAGE"
)
View Source 
const (
	// FlowExecutionStatusRunning is a FlowExecutionStatus enum value
	FlowExecutionStatusRunning = "RUNNING"

	// FlowExecutionStatusAborted is a FlowExecutionStatus enum value
	FlowExecutionStatusAborted = "ABORTED"

	// FlowExecutionStatusSucceeded is a FlowExecutionStatus enum value
	FlowExecutionStatusSucceeded = "SUCCEEDED"

	// FlowExecutionStatusFailed is a FlowExecutionStatus enum value
	FlowExecutionStatusFailed = "FAILED"
)
View Source 
const (
	// NamespaceDeletionStatusInProgress is a NamespaceDeletionStatus enum value
	NamespaceDeletionStatusInProgress = "IN_PROGRESS"

	// NamespaceDeletionStatusSucceeded is a NamespaceDeletionStatus enum value
	NamespaceDeletionStatusSucceeded = "SUCCEEDED"

	// NamespaceDeletionStatusFailed is a NamespaceDeletionStatus enum value
	NamespaceDeletionStatusFailed = "FAILED"
)
View Source 
const (
	// SystemInstanceDeploymentStatusNotDeployed is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusNotDeployed = "NOT_DEPLOYED"

	// SystemInstanceDeploymentStatusBootstrap is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusBootstrap = "BOOTSTRAP"

	// SystemInstanceDeploymentStatusDeployInProgress is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusDeployInProgress = "DEPLOY_IN_PROGRESS"

	// SystemInstanceDeploymentStatusDeployedInTarget is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusDeployedInTarget = "DEPLOYED_IN_TARGET"

	// SystemInstanceDeploymentStatusUndeployInProgress is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusUndeployInProgress = "UNDEPLOY_IN_PROGRESS"

	// SystemInstanceDeploymentStatusFailed is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusFailed = "FAILED"

	// SystemInstanceDeploymentStatusPendingDelete is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusPendingDelete = "PENDING_DELETE"

	// SystemInstanceDeploymentStatusDeletedInTarget is a SystemInstanceDeploymentStatus enum value
	SystemInstanceDeploymentStatusDeletedInTarget = "DELETED_IN_TARGET"
)
View Source 
const (
	// SystemInstanceFilterNameSystemTemplateId is a SystemInstanceFilterName enum value
	SystemInstanceFilterNameSystemTemplateId = "SYSTEM_TEMPLATE_ID"

	// SystemInstanceFilterNameStatus is a SystemInstanceFilterName enum value
	SystemInstanceFilterNameStatus = "STATUS"

	// SystemInstanceFilterNameGreengrassGroupName is a SystemInstanceFilterName enum value
	SystemInstanceFilterNameGreengrassGroupName = "GREENGRASS_GROUP_NAME"
)
View Source 
const (
	// UploadStatusInProgress is a UploadStatus enum value
	UploadStatusInProgress = "IN_PROGRESS"

	// UploadStatusSucceeded is a UploadStatus enum value
	UploadStatusSucceeded = "SUCCEEDED"

	// UploadStatusFailed is a UploadStatus enum value
	UploadStatusFailed = "FAILED"
)
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"
)
View Source 
const (
	ServiceName = "IoTThingsGraph" // Name of service.
	EndpointsID = "iotthingsgraph" // ID to lookup a service endpoint with.
	ServiceID   = "IoTThingsGraph" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// DefinitionLanguageGraphql is a DefinitionLanguage enum value
	DefinitionLanguageGraphql = "GRAPHQL"
)
View Source 
const (
	// FlowTemplateFilterNameDeviceModelId is a FlowTemplateFilterName enum value
	FlowTemplateFilterNameDeviceModelId = "DEVICE_MODEL_ID"
)
View Source 
const (
	// NamespaceDeletionStatusErrorCodesValidationFailed is a NamespaceDeletionStatusErrorCodes enum value
	NamespaceDeletionStatusErrorCodesValidationFailed = "VALIDATION_FAILED"
)
View Source 
const (
	// SystemTemplateFilterNameFlowTemplateId is a SystemTemplateFilterName enum value
	SystemTemplateFilterNameFlowTemplateId = "FLOW_TEMPLATE_ID"
)

Variables

This section is empty.

Functions

func DefinitionLanguage_Values added in v1.34.3 

func DefinitionLanguage_Values() []string

DefinitionLanguage_Values returns all elements of the DefinitionLanguage enum

func DeploymentTarget_Values added in v1.34.3 

func DeploymentTarget_Values() []string

DeploymentTarget_Values returns all elements of the DeploymentTarget enum

func EntityFilterName_Values added in v1.34.3 

func EntityFilterName_Values() []string

EntityFilterName_Values returns all elements of the EntityFilterName enum

func EntityType_Values added in v1.34.3 

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func FlowExecutionEventType_Values added in v1.34.3 

func FlowExecutionEventType_Values() []string

FlowExecutionEventType_Values returns all elements of the FlowExecutionEventType enum

func FlowExecutionStatus_Values added in v1.34.3 

func FlowExecutionStatus_Values() []string

FlowExecutionStatus_Values returns all elements of the FlowExecutionStatus enum

func FlowTemplateFilterName_Values added in v1.34.3 

func FlowTemplateFilterName_Values() []string

FlowTemplateFilterName_Values returns all elements of the FlowTemplateFilterName enum

func NamespaceDeletionStatusErrorCodes_Values added in v1.34.3 

func NamespaceDeletionStatusErrorCodes_Values() []string

NamespaceDeletionStatusErrorCodes_Values returns all elements of the NamespaceDeletionStatusErrorCodes enum

func NamespaceDeletionStatus_Values added in v1.34.3 

func NamespaceDeletionStatus_Values() []string

NamespaceDeletionStatus_Values returns all elements of the NamespaceDeletionStatus enum

func SystemInstanceDeploymentStatus_Values added in v1.34.3 

func SystemInstanceDeploymentStatus_Values() []string

SystemInstanceDeploymentStatus_Values returns all elements of the SystemInstanceDeploymentStatus enum

func SystemInstanceFilterName_Values added in v1.34.3 

func SystemInstanceFilterName_Values() []string

SystemInstanceFilterName_Values returns all elements of the SystemInstanceFilterName enum

func SystemTemplateFilterName_Values added in v1.34.3 

func SystemTemplateFilterName_Values() []string

SystemTemplateFilterName_Values returns all elements of the SystemTemplateFilterName enum

func UploadStatus_Values added in v1.34.3 

func UploadStatus_Values() []string

UploadStatus_Values returns all elements of the UploadStatus enum

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

func (s AssociateEntityToThingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateEntityToThingInput) SetEntityId 

func (s *AssociateEntityToThingInput) SetEntityId(v string) *AssociateEntityToThingInput

SetEntityId sets the EntityId field's value.

func (*AssociateEntityToThingInput) SetNamespaceVersion 

func (s *AssociateEntityToThingInput) SetNamespaceVersion(v int64) *AssociateEntityToThingInput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (*AssociateEntityToThingInput) SetThingName 

func (s *AssociateEntityToThingInput) SetThingName(v string) *AssociateEntityToThingInput

SetThingName sets the ThingName field's value.

func (AssociateEntityToThingInput) String 

func (s AssociateEntityToThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s AssociateEntityToThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateEntityToThingOutput) String 

func (s AssociateEntityToThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateFlowTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlowTemplateInput) SetCompatibleNamespaceVersion 

func (s *CreateFlowTemplateInput) SetCompatibleNamespaceVersion(v int64) *CreateFlowTemplateInput

SetCompatibleNamespaceVersion sets the CompatibleNamespaceVersion field's value.

func (*CreateFlowTemplateInput) SetDefinition 

func (s *CreateFlowTemplateInput) SetDefinition(v *DefinitionDocument) *CreateFlowTemplateInput

SetDefinition sets the Definition field's value.

func (CreateFlowTemplateInput) String 

func (s CreateFlowTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateFlowTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlowTemplateOutput) SetSummary 

func (s *CreateFlowTemplateOutput) SetSummary(v *FlowTemplateSummary) *CreateFlowTemplateOutput

SetSummary sets the Summary field's value.

func (CreateFlowTemplateOutput) String 

func (s CreateFlowTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"target" type:"string" required:"true" enum:"DeploymentTarget"`
	// contains filtered or unexported fields
}

func (CreateSystemInstanceInput) GoString 

func (s CreateSystemInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSystemInstanceInput) SetDefinition 

func (s *CreateSystemInstanceInput) SetDefinition(v *DefinitionDocument) *CreateSystemInstanceInput

SetDefinition sets the Definition field's value.

func (*CreateSystemInstanceInput) SetFlowActionsRoleArn 

func (s *CreateSystemInstanceInput) SetFlowActionsRoleArn(v string) *CreateSystemInstanceInput

SetFlowActionsRoleArn sets the FlowActionsRoleArn field's value.

func (*CreateSystemInstanceInput) SetGreengrassGroupName 

func (s *CreateSystemInstanceInput) SetGreengrassGroupName(v string) *CreateSystemInstanceInput

SetGreengrassGroupName sets the GreengrassGroupName field's value.

func (*CreateSystemInstanceInput) SetMetricsConfiguration 

func (s *CreateSystemInstanceInput) SetMetricsConfiguration(v *MetricsConfiguration) *CreateSystemInstanceInput

SetMetricsConfiguration sets the MetricsConfiguration field's value.

func (*CreateSystemInstanceInput) SetS3BucketName 

func (s *CreateSystemInstanceInput) SetS3BucketName(v string) *CreateSystemInstanceInput

SetS3BucketName sets the S3BucketName field's value.

func (*CreateSystemInstanceInput) SetTags 

func (s *CreateSystemInstanceInput) SetTags(v []*Tag) *CreateSystemInstanceInput

SetTags sets the Tags field's value.

func (*CreateSystemInstanceInput) SetTarget 

func (s *CreateSystemInstanceInput) SetTarget(v string) *CreateSystemInstanceInput

SetTarget sets the Target field's value.

func (CreateSystemInstanceInput) String 

func (s CreateSystemInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateSystemInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSystemInstanceOutput) SetSummary 

func (s *CreateSystemInstanceOutput) SetSummary(v *SystemInstanceSummary) *CreateSystemInstanceOutput

SetSummary sets the Summary field's value.

func (CreateSystemInstanceOutput) String 

func (s CreateSystemInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateSystemTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSystemTemplateInput) SetCompatibleNamespaceVersion 

func (s *CreateSystemTemplateInput) SetCompatibleNamespaceVersion(v int64) *CreateSystemTemplateInput

SetCompatibleNamespaceVersion sets the CompatibleNamespaceVersion field's value.

func (*CreateSystemTemplateInput) SetDefinition 

func (s *CreateSystemTemplateInput) SetDefinition(v *DefinitionDocument) *CreateSystemTemplateInput

SetDefinition sets the Definition field's value.

func (CreateSystemTemplateInput) String 

func (s CreateSystemTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateSystemTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSystemTemplateOutput) SetSummary 

func (s *CreateSystemTemplateOutput) SetSummary(v *SystemTemplateSummary) *CreateSystemTemplateOutput

SetSummary sets the Summary field's value.

func (CreateSystemTemplateOutput) String 

func (s CreateSystemTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefinitionDocument 

type DefinitionDocument struct {

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

	// 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) GoString 

func (s DefinitionDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefinitionDocument) SetLanguage 

func (s *DefinitionDocument) SetLanguage(v string) *DefinitionDocument

SetLanguage sets the Language field's value.

func (*DefinitionDocument) SetText 

func (s *DefinitionDocument) SetText(v string) *DefinitionDocument

SetText sets the Text field's value.

func (DefinitionDocument) String 

func (s DefinitionDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefinitionDocument) Validate 

func (s *DefinitionDocument) Validate() error

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

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

func (s DeleteFlowTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFlowTemplateInput) SetId 

func (s *DeleteFlowTemplateInput) SetId(v string) *DeleteFlowTemplateInput

SetId sets the Id field's value.

func (DeleteFlowTemplateInput) String 

func (s DeleteFlowTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteFlowTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFlowTemplateOutput) String 

func (s DeleteFlowTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNamespaceInput 

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

func (DeleteNamespaceInput) GoString 

func (s DeleteNamespaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNamespaceInput) String 

func (s DeleteNamespaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteNamespaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNamespaceOutput) SetNamespaceArn 

func (s *DeleteNamespaceOutput) SetNamespaceArn(v string) *DeleteNamespaceOutput

SetNamespaceArn sets the NamespaceArn field's value.

func (*DeleteNamespaceOutput) SetNamespaceName 

func (s *DeleteNamespaceOutput) SetNamespaceName(v string) *DeleteNamespaceOutput

SetNamespaceName sets the NamespaceName field's value.

func (DeleteNamespaceOutput) String 

func (s DeleteNamespaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteSystemInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSystemInstanceInput) SetId 

func (s *DeleteSystemInstanceInput) SetId(v string) *DeleteSystemInstanceInput

SetId sets the Id field's value.

func (DeleteSystemInstanceInput) String 

func (s DeleteSystemInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSystemInstanceOutput 

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

func (DeleteSystemInstanceOutput) GoString 

func (s DeleteSystemInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSystemInstanceOutput) String 

func (s DeleteSystemInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteSystemTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSystemTemplateInput) SetId 

func (s *DeleteSystemTemplateInput) SetId(v string) *DeleteSystemTemplateInput

SetId sets the Id field's value.

func (DeleteSystemTemplateInput) String 

func (s DeleteSystemTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteSystemTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSystemTemplateOutput) String 

func (s DeleteSystemTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DependencyRevision) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DependencyRevision) SetId 

func (s *DependencyRevision) SetId(v string) *DependencyRevision

SetId sets the Id field's value.

func (*DependencyRevision) SetRevisionNumber 

func (s *DependencyRevision) SetRevisionNumber(v int64) *DependencyRevision

SetRevisionNumber sets the RevisionNumber field's value.

func (DependencyRevision) String 

func (s DependencyRevision) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeploySystemInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploySystemInstanceInput) SetId 

func (s *DeploySystemInstanceInput) SetId(v string) *DeploySystemInstanceInput

SetId sets the Id field's value.

func (DeploySystemInstanceInput) String 

func (s DeploySystemInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeploySystemInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploySystemInstanceOutput) SetGreengrassDeploymentId 

func (s *DeploySystemInstanceOutput) SetGreengrassDeploymentId(v string) *DeploySystemInstanceOutput

SetGreengrassDeploymentId sets the GreengrassDeploymentId field's value.

func (*DeploySystemInstanceOutput) SetSummary 

func (s *DeploySystemInstanceOutput) SetSummary(v *SystemInstanceSummary) *DeploySystemInstanceOutput

SetSummary sets the Summary field's value.

func (DeploySystemInstanceOutput) String 

func (s DeploySystemInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeprecateFlowTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeprecateFlowTemplateInput) SetId 

func (s *DeprecateFlowTemplateInput) SetId(v string) *DeprecateFlowTemplateInput

SetId sets the Id field's value.

func (DeprecateFlowTemplateInput) String 

func (s DeprecateFlowTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeprecateFlowTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeprecateFlowTemplateOutput) String 

func (s DeprecateFlowTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeprecateSystemTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeprecateSystemTemplateInput) SetId 

func (s *DeprecateSystemTemplateInput) SetId(v string) *DeprecateSystemTemplateInput

SetId sets the Id field's value.

func (DeprecateSystemTemplateInput) String 

func (s DeprecateSystemTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeprecateSystemTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeprecateSystemTemplateOutput) String 

func (s DeprecateSystemTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeNamespaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNamespaceInput) SetNamespaceName 

func (s *DescribeNamespaceInput) SetNamespaceName(v string) *DescribeNamespaceInput

SetNamespaceName sets the NamespaceName field's value.

func (DescribeNamespaceInput) String 

func (s DescribeNamespaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeNamespaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNamespaceOutput) SetNamespaceArn 

func (s *DescribeNamespaceOutput) SetNamespaceArn(v string) *DescribeNamespaceOutput

SetNamespaceArn sets the NamespaceArn field's value.

func (*DescribeNamespaceOutput) SetNamespaceName 

func (s *DescribeNamespaceOutput) SetNamespaceName(v string) *DescribeNamespaceOutput

SetNamespaceName sets the NamespaceName field's value.

func (*DescribeNamespaceOutput) SetNamespaceVersion 

func (s *DescribeNamespaceOutput) SetNamespaceVersion(v int64) *DescribeNamespaceOutput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (*DescribeNamespaceOutput) SetTrackingNamespaceName 

func (s *DescribeNamespaceOutput) SetTrackingNamespaceName(v string) *DescribeNamespaceOutput

SetTrackingNamespaceName sets the TrackingNamespaceName field's value.

func (*DescribeNamespaceOutput) SetTrackingNamespaceVersion 

func (s *DescribeNamespaceOutput) SetTrackingNamespaceVersion(v int64) *DescribeNamespaceOutput

SetTrackingNamespaceVersion sets the TrackingNamespaceVersion field's value.

func (DescribeNamespaceOutput) String 

func (s DescribeNamespaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DissociateEntityFromThingInput 

type DissociateEntityFromThingInput struct {

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

	// 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) GoString 

func (s DissociateEntityFromThingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DissociateEntityFromThingInput) SetEntityType 

func (s *DissociateEntityFromThingInput) SetEntityType(v string) *DissociateEntityFromThingInput

SetEntityType sets the EntityType field's value.

func (*DissociateEntityFromThingInput) SetThingName 

func (s *DissociateEntityFromThingInput) SetThingName(v string) *DissociateEntityFromThingInput

SetThingName sets the ThingName field's value.

func (DissociateEntityFromThingInput) String 

func (s DissociateEntityFromThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DissociateEntityFromThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DissociateEntityFromThingOutput) String 

func (s DissociateEntityFromThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"type" type:"string" enum:"EntityType"`
	// contains filtered or unexported fields
}

Describes the properties of an entity.

func (EntityDescription) GoString 

func (s EntityDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityDescription) SetArn 

func (s *EntityDescription) SetArn(v string) *EntityDescription

SetArn sets the Arn field's value.

func (*EntityDescription) SetCreatedAt 

func (s *EntityDescription) SetCreatedAt(v time.Time) *EntityDescription

SetCreatedAt sets the CreatedAt field's value.

func (*EntityDescription) SetDefinition 

func (s *EntityDescription) SetDefinition(v *DefinitionDocument) *EntityDescription

SetDefinition sets the Definition field's value.

func (*EntityDescription) SetId 

func (s *EntityDescription) SetId(v string) *EntityDescription

SetId sets the Id field's value.

func (*EntityDescription) SetType 

func (s *EntityDescription) SetType(v string) *EntityDescription

SetType sets the Type field's value.

func (EntityDescription) String 

func (s EntityDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"name" type:"string" enum:"EntityFilterName"`

	// 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) GoString 

func (s EntityFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityFilter) SetName 

func (s *EntityFilter) SetName(v string) *EntityFilter

SetName sets the Name field's value.

func (*EntityFilter) SetValue 

func (s *EntityFilter) SetValue(v []*string) *EntityFilter

SetValue sets the Value field's value.

func (EntityFilter) String 

func (s EntityFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FlowExecutionMessage 

type FlowExecutionMessage struct {

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

	// 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) GoString 

func (s FlowExecutionMessage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowExecutionMessage) SetEventType 

func (s *FlowExecutionMessage) SetEventType(v string) *FlowExecutionMessage

SetEventType sets the EventType field's value.

func (*FlowExecutionMessage) SetMessageId 

func (s *FlowExecutionMessage) SetMessageId(v string) *FlowExecutionMessage

SetMessageId sets the MessageId field's value.

func (*FlowExecutionMessage) SetPayload 

func (s *FlowExecutionMessage) SetPayload(v string) *FlowExecutionMessage

SetPayload sets the Payload field's value.

func (*FlowExecutionMessage) SetTimestamp 

func (s *FlowExecutionMessage) SetTimestamp(v time.Time) *FlowExecutionMessage

SetTimestamp sets the Timestamp field's value.

func (FlowExecutionMessage) String 

func (s FlowExecutionMessage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"status" type:"string" enum:"FlowExecutionStatus"`

	// 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) GoString 

func (s FlowExecutionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowExecutionSummary) SetCreatedAt 

func (s *FlowExecutionSummary) SetCreatedAt(v time.Time) *FlowExecutionSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FlowExecutionSummary) SetFlowExecutionId 

func (s *FlowExecutionSummary) SetFlowExecutionId(v string) *FlowExecutionSummary

SetFlowExecutionId sets the FlowExecutionId field's value.

func (*FlowExecutionSummary) SetFlowTemplateId 

func (s *FlowExecutionSummary) SetFlowTemplateId(v string) *FlowExecutionSummary

SetFlowTemplateId sets the FlowTemplateId field's value.

func (*FlowExecutionSummary) SetStatus 

func (s *FlowExecutionSummary) SetStatus(v string) *FlowExecutionSummary

SetStatus sets the Status field's value.

func (*FlowExecutionSummary) SetSystemInstanceId 

func (s *FlowExecutionSummary) SetSystemInstanceId(v string) *FlowExecutionSummary

SetSystemInstanceId sets the SystemInstanceId field's value.

func (*FlowExecutionSummary) SetUpdatedAt 

func (s *FlowExecutionSummary) SetUpdatedAt(v time.Time) *FlowExecutionSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (FlowExecutionSummary) String 

func (s FlowExecutionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s FlowTemplateDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowTemplateDescription) SetDefinition 

func (s *FlowTemplateDescription) SetDefinition(v *DefinitionDocument) *FlowTemplateDescription

SetDefinition sets the Definition field's value.

func (*FlowTemplateDescription) SetSummary 

func (s *FlowTemplateDescription) SetSummary(v *FlowTemplateSummary) *FlowTemplateDescription

SetSummary sets the Summary field's value.

func (*FlowTemplateDescription) SetValidatedNamespaceVersion 

func (s *FlowTemplateDescription) SetValidatedNamespaceVersion(v int64) *FlowTemplateDescription

SetValidatedNamespaceVersion sets the ValidatedNamespaceVersion field's value.

func (FlowTemplateDescription) String 

func (s FlowTemplateDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FlowTemplateFilter 

type FlowTemplateFilter struct {

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

	// 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) GoString 

func (s FlowTemplateFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowTemplateFilter) SetName 

func (s *FlowTemplateFilter) SetName(v string) *FlowTemplateFilter

SetName sets the Name field's value.

func (*FlowTemplateFilter) SetValue 

func (s *FlowTemplateFilter) SetValue(v []*string) *FlowTemplateFilter

SetValue sets the Value field's value.

func (FlowTemplateFilter) String 

func (s FlowTemplateFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowTemplateFilter) Validate 

func (s *FlowTemplateFilter) Validate() error

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

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

func (s FlowTemplateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FlowTemplateSummary) SetArn 

func (s *FlowTemplateSummary) SetArn(v string) *FlowTemplateSummary

SetArn sets the Arn field's value.

func (*FlowTemplateSummary) SetCreatedAt 

func (s *FlowTemplateSummary) SetCreatedAt(v time.Time) *FlowTemplateSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FlowTemplateSummary) SetId 

func (s *FlowTemplateSummary) SetId(v string) *FlowTemplateSummary

SetId sets the Id field's value.

func (*FlowTemplateSummary) SetRevisionNumber 

func (s *FlowTemplateSummary) SetRevisionNumber(v int64) *FlowTemplateSummary

SetRevisionNumber sets the RevisionNumber field's value.

func (FlowTemplateSummary) String 

func (s FlowTemplateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEntitiesInput) SetIds 

func (s *GetEntitiesInput) SetIds(v []*string) *GetEntitiesInput

SetIds sets the Ids field's value.

func (*GetEntitiesInput) SetNamespaceVersion 

func (s *GetEntitiesInput) SetNamespaceVersion(v int64) *GetEntitiesInput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (GetEntitiesInput) String 

func (s GetEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEntitiesOutput) SetDescriptions 

func (s *GetEntitiesOutput) SetDescriptions(v []*EntityDescription) *GetEntitiesOutput

SetDescriptions sets the Descriptions field's value.

func (GetEntitiesOutput) String 

func (s GetEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetFlowTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFlowTemplateInput) SetId 

func (s *GetFlowTemplateInput) SetId(v string) *GetFlowTemplateInput

SetId sets the Id field's value.

func (*GetFlowTemplateInput) SetRevisionNumber 

func (s *GetFlowTemplateInput) SetRevisionNumber(v int64) *GetFlowTemplateInput

SetRevisionNumber sets the RevisionNumber field's value.

func (GetFlowTemplateInput) String 

func (s GetFlowTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetFlowTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFlowTemplateOutput) SetDescription 

func (s *GetFlowTemplateOutput) SetDescription(v *FlowTemplateDescription) *GetFlowTemplateOutput

SetDescription sets the Description field's value.

func (GetFlowTemplateOutput) String 

func (s GetFlowTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetFlowTemplateRevisionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFlowTemplateRevisionsInput) SetId 

func (s *GetFlowTemplateRevisionsInput) SetId(v string) *GetFlowTemplateRevisionsInput

SetId sets the Id field's value.

func (*GetFlowTemplateRevisionsInput) SetMaxResults 

func (s *GetFlowTemplateRevisionsInput) SetMaxResults(v int64) *GetFlowTemplateRevisionsInput

SetMaxResults sets the MaxResults field's value.

func (*GetFlowTemplateRevisionsInput) SetNextToken 

func (s *GetFlowTemplateRevisionsInput) SetNextToken(v string) *GetFlowTemplateRevisionsInput

SetNextToken sets the NextToken field's value.

func (GetFlowTemplateRevisionsInput) String 

func (s GetFlowTemplateRevisionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetFlowTemplateRevisionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFlowTemplateRevisionsOutput) SetNextToken 

func (s *GetFlowTemplateRevisionsOutput) SetNextToken(v string) *GetFlowTemplateRevisionsOutput

SetNextToken sets the NextToken field's value.

func (*GetFlowTemplateRevisionsOutput) SetSummaries 

func (s *GetFlowTemplateRevisionsOutput) SetSummaries(v []*FlowTemplateSummary) *GetFlowTemplateRevisionsOutput

SetSummaries sets the Summaries field's value.

func (GetFlowTemplateRevisionsOutput) String 

func (s GetFlowTemplateRevisionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetNamespaceDeletionStatusInput 

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

func (GetNamespaceDeletionStatusInput) GoString 

func (s GetNamespaceDeletionStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetNamespaceDeletionStatusInput) String 

func (s GetNamespaceDeletionStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetNamespaceDeletionStatusOutput 

type GetNamespaceDeletionStatusOutput struct {

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

	// 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 *string `locationName:"status" type:"string" enum:"NamespaceDeletionStatus"`
	// contains filtered or unexported fields
}

func (GetNamespaceDeletionStatusOutput) GoString 

func (s GetNamespaceDeletionStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetNamespaceDeletionStatusOutput) SetErrorCode 

func (s *GetNamespaceDeletionStatusOutput) SetErrorCode(v string) *GetNamespaceDeletionStatusOutput

SetErrorCode sets the ErrorCode field's value.

func (*GetNamespaceDeletionStatusOutput) SetErrorMessage 

func (s *GetNamespaceDeletionStatusOutput) SetErrorMessage(v string) *GetNamespaceDeletionStatusOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*GetNamespaceDeletionStatusOutput) SetNamespaceArn 

func (s *GetNamespaceDeletionStatusOutput) SetNamespaceArn(v string) *GetNamespaceDeletionStatusOutput

SetNamespaceArn sets the NamespaceArn field's value.

func (*GetNamespaceDeletionStatusOutput) SetNamespaceName 

func (s *GetNamespaceDeletionStatusOutput) SetNamespaceName(v string) *GetNamespaceDeletionStatusOutput

SetNamespaceName sets the NamespaceName field's value.

func (*GetNamespaceDeletionStatusOutput) SetStatus 

func (s *GetNamespaceDeletionStatusOutput) SetStatus(v string) *GetNamespaceDeletionStatusOutput

SetStatus sets the Status field's value.

func (GetNamespaceDeletionStatusOutput) String 

func (s GetNamespaceDeletionStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemInstanceInput) SetId 

func (s *GetSystemInstanceInput) SetId(v string) *GetSystemInstanceInput

SetId sets the Id field's value.

func (GetSystemInstanceInput) String 

func (s GetSystemInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemInstanceOutput) SetDescription 

func (s *GetSystemInstanceOutput) SetDescription(v *SystemInstanceDescription) *GetSystemInstanceOutput

SetDescription sets the Description field's value.

func (GetSystemInstanceOutput) String 

func (s GetSystemInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemTemplateInput) SetId 

func (s *GetSystemTemplateInput) SetId(v string) *GetSystemTemplateInput

SetId sets the Id field's value.

func (*GetSystemTemplateInput) SetRevisionNumber 

func (s *GetSystemTemplateInput) SetRevisionNumber(v int64) *GetSystemTemplateInput

SetRevisionNumber sets the RevisionNumber field's value.

func (GetSystemTemplateInput) String 

func (s GetSystemTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemTemplateOutput) SetDescription 

func (s *GetSystemTemplateOutput) SetDescription(v *SystemTemplateDescription) *GetSystemTemplateOutput

SetDescription sets the Description field's value.

func (GetSystemTemplateOutput) String 

func (s GetSystemTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemTemplateRevisionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemTemplateRevisionsInput) SetId 

func (s *GetSystemTemplateRevisionsInput) SetId(v string) *GetSystemTemplateRevisionsInput

SetId sets the Id field's value.

func (*GetSystemTemplateRevisionsInput) SetMaxResults 

func (s *GetSystemTemplateRevisionsInput) SetMaxResults(v int64) *GetSystemTemplateRevisionsInput

SetMaxResults sets the MaxResults field's value.

func (*GetSystemTemplateRevisionsInput) SetNextToken 

func (s *GetSystemTemplateRevisionsInput) SetNextToken(v string) *GetSystemTemplateRevisionsInput

SetNextToken sets the NextToken field's value.

func (GetSystemTemplateRevisionsInput) String 

func (s GetSystemTemplateRevisionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetSystemTemplateRevisionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSystemTemplateRevisionsOutput) SetNextToken 

func (s *GetSystemTemplateRevisionsOutput) SetNextToken(v string) *GetSystemTemplateRevisionsOutput

SetNextToken sets the NextToken field's value.

func (*GetSystemTemplateRevisionsOutput) SetSummaries 

func (s *GetSystemTemplateRevisionsOutput) SetSummaries(v []*SystemTemplateSummary) *GetSystemTemplateRevisionsOutput

SetSummaries sets the Summaries field's value.

func (GetSystemTemplateRevisionsOutput) String 

func (s GetSystemTemplateRevisionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s GetUploadStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUploadStatusInput) SetUploadId 

func (s *GetUploadStatusInput) SetUploadId(v string) *GetUploadStatusInput

SetUploadId sets the UploadId field's value.

func (GetUploadStatusInput) String 

func (s GetUploadStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"uploadStatus" type:"string" required:"true" enum:"UploadStatus"`
	// contains filtered or unexported fields
}

func (GetUploadStatusOutput) GoString 

func (s GetUploadStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetUploadStatusOutput) SetCreatedDate 

func (s *GetUploadStatusOutput) SetCreatedDate(v time.Time) *GetUploadStatusOutput

SetCreatedDate sets the CreatedDate field's value.

func (*GetUploadStatusOutput) SetFailureReason 

func (s *GetUploadStatusOutput) SetFailureReason(v []*string) *GetUploadStatusOutput

SetFailureReason sets the FailureReason field's value.

func (*GetUploadStatusOutput) SetNamespaceArn 

func (s *GetUploadStatusOutput) SetNamespaceArn(v string) *GetUploadStatusOutput

SetNamespaceArn sets the NamespaceArn field's value.

func (*GetUploadStatusOutput) SetNamespaceName 

func (s *GetUploadStatusOutput) SetNamespaceName(v string) *GetUploadStatusOutput

SetNamespaceName sets the NamespaceName field's value.

func (*GetUploadStatusOutput) SetNamespaceVersion 

func (s *GetUploadStatusOutput) SetNamespaceVersion(v int64) *GetUploadStatusOutput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (*GetUploadStatusOutput) SetUploadId 

func (s *GetUploadStatusOutput) SetUploadId(v string) *GetUploadStatusOutput

SetUploadId sets the UploadId field's value.

func (*GetUploadStatusOutput) SetUploadStatus 

func (s *GetUploadStatusOutput) SetUploadStatus(v string) *GetUploadStatusOutput

SetUploadStatus sets the UploadStatus field's value.

func (GetUploadStatusOutput) String 

func (s GetUploadStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException added in v1.28.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTThingsGraph 

type IoTThingsGraph struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTThingsGraph

New creates a new instance of the IoTThingsGraph client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a IoTThingsGraph client from just a session.
svc := iotthingsgraph.New(mySession)

// Create a IoTThingsGraph client with additional configuration
svc := iotthingsgraph.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTThingsGraph) AssociateEntityToThing deprecated 

func (c *IoTThingsGraph) AssociateEntityToThing(input *AssociateEntityToThingInput) (*AssociateEntityToThingOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation AssociateEntityToThing for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) AssociateEntityToThingRequest deprecated 

func (c *IoTThingsGraph) AssociateEntityToThingRequest(input *AssociateEntityToThingInput) (req *request.Request, output *AssociateEntityToThingOutput)

AssociateEntityToThingRequest generates a "aws/request.Request" representing the client's request for the AssociateEntityToThing operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateEntityToThing for more information on using the AssociateEntityToThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateEntityToThingRequest method.
req, resp := client.AssociateEntityToThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) AssociateEntityToThingWithContext deprecated 

func (c *IoTThingsGraph) AssociateEntityToThingWithContext(ctx aws.Context, input *AssociateEntityToThingInput, opts ...request.Option) (*AssociateEntityToThingOutput, error)

AssociateEntityToThingWithContext is the same as AssociateEntityToThing with the addition of the ability to pass a context and additional request options.

See AssociateEntityToThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateFlowTemplate deprecated 

func (c *IoTThingsGraph) CreateFlowTemplate(input *CreateFlowTemplateInput) (*CreateFlowTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation CreateFlowTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • LimitExceededException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateFlowTemplateRequest deprecated 

func (c *IoTThingsGraph) CreateFlowTemplateRequest(input *CreateFlowTemplateInput) (req *request.Request, output *CreateFlowTemplateOutput)

CreateFlowTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateFlowTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFlowTemplate for more information on using the CreateFlowTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFlowTemplateRequest method.
req, resp := client.CreateFlowTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateFlowTemplateWithContext deprecated 

func (c *IoTThingsGraph) CreateFlowTemplateWithContext(ctx aws.Context, input *CreateFlowTemplateInput, opts ...request.Option) (*CreateFlowTemplateOutput, error)

CreateFlowTemplateWithContext is the same as CreateFlowTemplate with the addition of the ability to pass a context and additional request options.

See CreateFlowTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemInstance deprecated 

func (c *IoTThingsGraph) CreateSystemInstance(input *CreateSystemInstanceInput) (*CreateSystemInstanceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation CreateSystemInstance for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • InternalFailureException

  • LimitExceededException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemInstanceRequest deprecated 

func (c *IoTThingsGraph) CreateSystemInstanceRequest(input *CreateSystemInstanceInput) (req *request.Request, output *CreateSystemInstanceOutput)

CreateSystemInstanceRequest generates a "aws/request.Request" representing the client's request for the CreateSystemInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSystemInstance for more information on using the CreateSystemInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSystemInstanceRequest method.
req, resp := client.CreateSystemInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemInstanceWithContext deprecated 

func (c *IoTThingsGraph) CreateSystemInstanceWithContext(ctx aws.Context, input *CreateSystemInstanceInput, opts ...request.Option) (*CreateSystemInstanceOutput, error)

CreateSystemInstanceWithContext is the same as CreateSystemInstance with the addition of the ability to pass a context and additional request options.

See CreateSystemInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemTemplate deprecated 

func (c *IoTThingsGraph) CreateSystemTemplate(input *CreateSystemTemplateInput) (*CreateSystemTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation CreateSystemTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemTemplateRequest deprecated 

func (c *IoTThingsGraph) CreateSystemTemplateRequest(input *CreateSystemTemplateInput) (req *request.Request, output *CreateSystemTemplateOutput)

CreateSystemTemplateRequest generates a "aws/request.Request" representing the client's request for the CreateSystemTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSystemTemplate for more information on using the CreateSystemTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSystemTemplateRequest method.
req, resp := client.CreateSystemTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) CreateSystemTemplateWithContext deprecated 

func (c *IoTThingsGraph) CreateSystemTemplateWithContext(ctx aws.Context, input *CreateSystemTemplateInput, opts ...request.Option) (*CreateSystemTemplateOutput, error)

CreateSystemTemplateWithContext is the same as CreateSystemTemplate with the addition of the ability to pass a context and additional request options.

See CreateSystemTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteFlowTemplate deprecated 

func (c *IoTThingsGraph) DeleteFlowTemplate(input *DeleteFlowTemplateInput) (*DeleteFlowTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeleteFlowTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceInUseException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteFlowTemplateRequest deprecated 

func (c *IoTThingsGraph) DeleteFlowTemplateRequest(input *DeleteFlowTemplateInput) (req *request.Request, output *DeleteFlowTemplateOutput)

DeleteFlowTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteFlowTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFlowTemplate for more information on using the DeleteFlowTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFlowTemplateRequest method.
req, resp := client.DeleteFlowTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteFlowTemplateWithContext deprecated 

func (c *IoTThingsGraph) DeleteFlowTemplateWithContext(ctx aws.Context, input *DeleteFlowTemplateInput, opts ...request.Option) (*DeleteFlowTemplateOutput, error)

DeleteFlowTemplateWithContext is the same as DeleteFlowTemplate with the addition of the ability to pass a context and additional request options.

See DeleteFlowTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteNamespace deprecated 

func (c *IoTThingsGraph) DeleteNamespace(input *DeleteNamespaceInput) (*DeleteNamespaceOutput, error)

DeleteNamespace 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. This action takes no request parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeleteNamespace for usage and error information.

Returned Error Types:

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteNamespaceRequest deprecated 

func (c *IoTThingsGraph) DeleteNamespaceRequest(input *DeleteNamespaceInput) (req *request.Request, output *DeleteNamespaceOutput)

DeleteNamespaceRequest generates a "aws/request.Request" representing the client's request for the DeleteNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNamespace for more information on using the DeleteNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteNamespaceRequest method.
req, resp := client.DeleteNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteNamespaceWithContext deprecated 

func (c *IoTThingsGraph) DeleteNamespaceWithContext(ctx aws.Context, input *DeleteNamespaceInput, opts ...request.Option) (*DeleteNamespaceOutput, error)

DeleteNamespaceWithContext is the same as DeleteNamespace with the addition of the ability to pass a context and additional request options.

See DeleteNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemInstance deprecated 

func (c *IoTThingsGraph) DeleteSystemInstance(input *DeleteSystemInstanceInput) (*DeleteSystemInstanceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeleteSystemInstance for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceInUseException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemInstanceRequest deprecated 

func (c *IoTThingsGraph) DeleteSystemInstanceRequest(input *DeleteSystemInstanceInput) (req *request.Request, output *DeleteSystemInstanceOutput)

DeleteSystemInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteSystemInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSystemInstance for more information on using the DeleteSystemInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSystemInstanceRequest method.
req, resp := client.DeleteSystemInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemInstanceWithContext deprecated 

func (c *IoTThingsGraph) DeleteSystemInstanceWithContext(ctx aws.Context, input *DeleteSystemInstanceInput, opts ...request.Option) (*DeleteSystemInstanceOutput, error)

DeleteSystemInstanceWithContext is the same as DeleteSystemInstance with the addition of the ability to pass a context and additional request options.

See DeleteSystemInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemTemplate deprecated 

func (c *IoTThingsGraph) DeleteSystemTemplate(input *DeleteSystemTemplateInput) (*DeleteSystemTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeleteSystemTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceInUseException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemTemplateRequest deprecated 

func (c *IoTThingsGraph) DeleteSystemTemplateRequest(input *DeleteSystemTemplateInput) (req *request.Request, output *DeleteSystemTemplateOutput)

DeleteSystemTemplateRequest generates a "aws/request.Request" representing the client's request for the DeleteSystemTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSystemTemplate for more information on using the DeleteSystemTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSystemTemplateRequest method.
req, resp := client.DeleteSystemTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeleteSystemTemplateWithContext deprecated 

func (c *IoTThingsGraph) DeleteSystemTemplateWithContext(ctx aws.Context, input *DeleteSystemTemplateInput, opts ...request.Option) (*DeleteSystemTemplateOutput, error)

DeleteSystemTemplateWithContext is the same as DeleteSystemTemplate with the addition of the ability to pass a context and additional request options.

See DeleteSystemTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeploySystemInstance deprecated 

func (c *IoTThingsGraph) DeploySystemInstance(input *DeploySystemInstanceInput) (*DeploySystemInstanceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeploySystemInstance for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceInUseException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeploySystemInstanceRequest deprecated 

func (c *IoTThingsGraph) DeploySystemInstanceRequest(input *DeploySystemInstanceInput) (req *request.Request, output *DeploySystemInstanceOutput)

DeploySystemInstanceRequest generates a "aws/request.Request" representing the client's request for the DeploySystemInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeploySystemInstance for more information on using the DeploySystemInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeploySystemInstanceRequest method.
req, resp := client.DeploySystemInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeploySystemInstanceWithContext deprecated 

func (c *IoTThingsGraph) DeploySystemInstanceWithContext(ctx aws.Context, input *DeploySystemInstanceInput, opts ...request.Option) (*DeploySystemInstanceOutput, error)

DeploySystemInstanceWithContext is the same as DeploySystemInstance with the addition of the ability to pass a context and additional request options.

See DeploySystemInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateFlowTemplate deprecated 

func (c *IoTThingsGraph) DeprecateFlowTemplate(input *DeprecateFlowTemplateInput) (*DeprecateFlowTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeprecateFlowTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateFlowTemplateRequest deprecated 

func (c *IoTThingsGraph) DeprecateFlowTemplateRequest(input *DeprecateFlowTemplateInput) (req *request.Request, output *DeprecateFlowTemplateOutput)

DeprecateFlowTemplateRequest generates a "aws/request.Request" representing the client's request for the DeprecateFlowTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateFlowTemplate for more information on using the DeprecateFlowTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeprecateFlowTemplateRequest method.
req, resp := client.DeprecateFlowTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateFlowTemplateWithContext deprecated 

func (c *IoTThingsGraph) DeprecateFlowTemplateWithContext(ctx aws.Context, input *DeprecateFlowTemplateInput, opts ...request.Option) (*DeprecateFlowTemplateOutput, error)

DeprecateFlowTemplateWithContext is the same as DeprecateFlowTemplate with the addition of the ability to pass a context and additional request options.

See DeprecateFlowTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateSystemTemplate deprecated 

func (c *IoTThingsGraph) DeprecateSystemTemplate(input *DeprecateSystemTemplateInput) (*DeprecateSystemTemplateOutput, error)

DeprecateSystemTemplate API operation for AWS IoT Things Graph.

Deprecates the specified system.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DeprecateSystemTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateSystemTemplateRequest deprecated 

func (c *IoTThingsGraph) DeprecateSystemTemplateRequest(input *DeprecateSystemTemplateInput) (req *request.Request, output *DeprecateSystemTemplateOutput)

DeprecateSystemTemplateRequest generates a "aws/request.Request" representing the client's request for the DeprecateSystemTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateSystemTemplate for more information on using the DeprecateSystemTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeprecateSystemTemplateRequest method.
req, resp := client.DeprecateSystemTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DeprecateSystemTemplateWithContext deprecated 

func (c *IoTThingsGraph) DeprecateSystemTemplateWithContext(ctx aws.Context, input *DeprecateSystemTemplateInput, opts ...request.Option) (*DeprecateSystemTemplateOutput, error)

DeprecateSystemTemplateWithContext is the same as DeprecateSystemTemplate with the addition of the ability to pass a context and additional request options.

See DeprecateSystemTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DescribeNamespace deprecated 

func (c *IoTThingsGraph) DescribeNamespace(input *DescribeNamespaceInput) (*DescribeNamespaceOutput, error)

DescribeNamespace API operation for AWS IoT Things Graph.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DescribeNamespace for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DescribeNamespaceRequest deprecated 

func (c *IoTThingsGraph) DescribeNamespaceRequest(input *DescribeNamespaceInput) (req *request.Request, output *DescribeNamespaceOutput)

DescribeNamespaceRequest generates a "aws/request.Request" representing the client's request for the DescribeNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNamespace for more information on using the DescribeNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNamespaceRequest method.
req, resp := client.DescribeNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DescribeNamespaceWithContext deprecated 

func (c *IoTThingsGraph) DescribeNamespaceWithContext(ctx aws.Context, input *DescribeNamespaceInput, opts ...request.Option) (*DescribeNamespaceOutput, error)

DescribeNamespaceWithContext is the same as DescribeNamespace with the addition of the ability to pass a context and additional request options.

See DescribeNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DissociateEntityFromThing deprecated 

func (c *IoTThingsGraph) DissociateEntityFromThing(input *DissociateEntityFromThingInput) (*DissociateEntityFromThingOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation DissociateEntityFromThing for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DissociateEntityFromThingRequest deprecated 

func (c *IoTThingsGraph) DissociateEntityFromThingRequest(input *DissociateEntityFromThingInput) (req *request.Request, output *DissociateEntityFromThingOutput)

DissociateEntityFromThingRequest generates a "aws/request.Request" representing the client's request for the DissociateEntityFromThing operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DissociateEntityFromThing for more information on using the DissociateEntityFromThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DissociateEntityFromThingRequest method.
req, resp := client.DissociateEntityFromThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) DissociateEntityFromThingWithContext deprecated 

func (c *IoTThingsGraph) DissociateEntityFromThingWithContext(ctx aws.Context, input *DissociateEntityFromThingInput, opts ...request.Option) (*DissociateEntityFromThingOutput, error)

DissociateEntityFromThingWithContext is the same as DissociateEntityFromThing with the addition of the ability to pass a context and additional request options.

See DissociateEntityFromThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetEntities deprecated 

func (c *IoTThingsGraph) GetEntities(input *GetEntitiesInput) (*GetEntitiesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetEntities for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetEntitiesRequest deprecated 

func (c *IoTThingsGraph) GetEntitiesRequest(input *GetEntitiesInput) (req *request.Request, output *GetEntitiesOutput)

GetEntitiesRequest generates a "aws/request.Request" representing the client's request for the GetEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEntities for more information on using the GetEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetEntitiesRequest method.
req, resp := client.GetEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetEntitiesWithContext deprecated 

func (c *IoTThingsGraph) GetEntitiesWithContext(ctx aws.Context, input *GetEntitiesInput, opts ...request.Option) (*GetEntitiesOutput, error)

GetEntitiesWithContext is the same as GetEntities with the addition of the ability to pass a context and additional request options.

See GetEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplate deprecated 

func (c *IoTThingsGraph) GetFlowTemplate(input *GetFlowTemplateInput) (*GetFlowTemplateOutput, error)

GetFlowTemplate API operation for AWS IoT Things Graph.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetFlowTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRequest deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRequest(input *GetFlowTemplateInput) (req *request.Request, output *GetFlowTemplateOutput)

GetFlowTemplateRequest generates a "aws/request.Request" representing the client's request for the GetFlowTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFlowTemplate for more information on using the GetFlowTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFlowTemplateRequest method.
req, resp := client.GetFlowTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRevisions deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRevisions(input *GetFlowTemplateRevisionsInput) (*GetFlowTemplateRevisionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetFlowTemplateRevisions for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRevisionsPages deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRevisionsPages(input *GetFlowTemplateRevisionsInput, fn func(*GetFlowTemplateRevisionsOutput, bool) bool) error

GetFlowTemplateRevisionsPages iterates over the pages of a GetFlowTemplateRevisions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFlowTemplateRevisions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetFlowTemplateRevisions operation.
pageNum := 0
err := client.GetFlowTemplateRevisionsPages(params,
    func(page *iotthingsgraph.GetFlowTemplateRevisionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRevisionsPagesWithContext deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRevisionsPagesWithContext(ctx aws.Context, input *GetFlowTemplateRevisionsInput, fn func(*GetFlowTemplateRevisionsOutput, bool) bool, opts ...request.Option) error

GetFlowTemplateRevisionsPagesWithContext same as GetFlowTemplateRevisionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRevisionsRequest deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRevisionsRequest(input *GetFlowTemplateRevisionsInput) (req *request.Request, output *GetFlowTemplateRevisionsOutput)

GetFlowTemplateRevisionsRequest generates a "aws/request.Request" representing the client's request for the GetFlowTemplateRevisions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFlowTemplateRevisions for more information on using the GetFlowTemplateRevisions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetFlowTemplateRevisionsRequest method.
req, resp := client.GetFlowTemplateRevisionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateRevisionsWithContext deprecated 

func (c *IoTThingsGraph) GetFlowTemplateRevisionsWithContext(ctx aws.Context, input *GetFlowTemplateRevisionsInput, opts ...request.Option) (*GetFlowTemplateRevisionsOutput, error)

GetFlowTemplateRevisionsWithContext is the same as GetFlowTemplateRevisions with the addition of the ability to pass a context and additional request options.

See GetFlowTemplateRevisions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetFlowTemplateWithContext deprecated 

func (c *IoTThingsGraph) GetFlowTemplateWithContext(ctx aws.Context, input *GetFlowTemplateInput, opts ...request.Option) (*GetFlowTemplateOutput, error)

GetFlowTemplateWithContext is the same as GetFlowTemplate with the addition of the ability to pass a context and additional request options.

See GetFlowTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetNamespaceDeletionStatus deprecated 

func (c *IoTThingsGraph) GetNamespaceDeletionStatus(input *GetNamespaceDeletionStatusInput) (*GetNamespaceDeletionStatusOutput, error)

GetNamespaceDeletionStatus API operation for AWS IoT Things Graph.

Gets the status of a namespace deletion task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetNamespaceDeletionStatus for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetNamespaceDeletionStatusRequest deprecated 

func (c *IoTThingsGraph) GetNamespaceDeletionStatusRequest(input *GetNamespaceDeletionStatusInput) (req *request.Request, output *GetNamespaceDeletionStatusOutput)

GetNamespaceDeletionStatusRequest generates a "aws/request.Request" representing the client's request for the GetNamespaceDeletionStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetNamespaceDeletionStatus for more information on using the GetNamespaceDeletionStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetNamespaceDeletionStatusRequest method.
req, resp := client.GetNamespaceDeletionStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetNamespaceDeletionStatusWithContext deprecated 

func (c *IoTThingsGraph) GetNamespaceDeletionStatusWithContext(ctx aws.Context, input *GetNamespaceDeletionStatusInput, opts ...request.Option) (*GetNamespaceDeletionStatusOutput, error)

GetNamespaceDeletionStatusWithContext is the same as GetNamespaceDeletionStatus with the addition of the ability to pass a context and additional request options.

See GetNamespaceDeletionStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemInstance deprecated 

func (c *IoTThingsGraph) GetSystemInstance(input *GetSystemInstanceInput) (*GetSystemInstanceOutput, error)

GetSystemInstance API operation for AWS IoT Things Graph.

Gets a system instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetSystemInstance for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemInstanceRequest deprecated 

func (c *IoTThingsGraph) GetSystemInstanceRequest(input *GetSystemInstanceInput) (req *request.Request, output *GetSystemInstanceOutput)

GetSystemInstanceRequest generates a "aws/request.Request" representing the client's request for the GetSystemInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSystemInstance for more information on using the GetSystemInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSystemInstanceRequest method.
req, resp := client.GetSystemInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemInstanceWithContext deprecated 

func (c *IoTThingsGraph) GetSystemInstanceWithContext(ctx aws.Context, input *GetSystemInstanceInput, opts ...request.Option) (*GetSystemInstanceOutput, error)

GetSystemInstanceWithContext is the same as GetSystemInstance with the addition of the ability to pass a context and additional request options.

See GetSystemInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplate deprecated 

func (c *IoTThingsGraph) GetSystemTemplate(input *GetSystemTemplateInput) (*GetSystemTemplateOutput, error)

GetSystemTemplate API operation for AWS IoT Things Graph.

Gets a system.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetSystemTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRequest deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRequest(input *GetSystemTemplateInput) (req *request.Request, output *GetSystemTemplateOutput)

GetSystemTemplateRequest generates a "aws/request.Request" representing the client's request for the GetSystemTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSystemTemplate for more information on using the GetSystemTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSystemTemplateRequest method.
req, resp := client.GetSystemTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRevisions deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRevisions(input *GetSystemTemplateRevisionsInput) (*GetSystemTemplateRevisionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetSystemTemplateRevisions for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRevisionsPages deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRevisionsPages(input *GetSystemTemplateRevisionsInput, fn func(*GetSystemTemplateRevisionsOutput, bool) bool) error

GetSystemTemplateRevisionsPages iterates over the pages of a GetSystemTemplateRevisions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetSystemTemplateRevisions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a GetSystemTemplateRevisions operation.
pageNum := 0
err := client.GetSystemTemplateRevisionsPages(params,
    func(page *iotthingsgraph.GetSystemTemplateRevisionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRevisionsPagesWithContext deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRevisionsPagesWithContext(ctx aws.Context, input *GetSystemTemplateRevisionsInput, fn func(*GetSystemTemplateRevisionsOutput, bool) bool, opts ...request.Option) error

GetSystemTemplateRevisionsPagesWithContext same as GetSystemTemplateRevisionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRevisionsRequest deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRevisionsRequest(input *GetSystemTemplateRevisionsInput) (req *request.Request, output *GetSystemTemplateRevisionsOutput)

GetSystemTemplateRevisionsRequest generates a "aws/request.Request" representing the client's request for the GetSystemTemplateRevisions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSystemTemplateRevisions for more information on using the GetSystemTemplateRevisions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSystemTemplateRevisionsRequest method.
req, resp := client.GetSystemTemplateRevisionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateRevisionsWithContext deprecated 

func (c *IoTThingsGraph) GetSystemTemplateRevisionsWithContext(ctx aws.Context, input *GetSystemTemplateRevisionsInput, opts ...request.Option) (*GetSystemTemplateRevisionsOutput, error)

GetSystemTemplateRevisionsWithContext is the same as GetSystemTemplateRevisions with the addition of the ability to pass a context and additional request options.

See GetSystemTemplateRevisions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetSystemTemplateWithContext deprecated 

func (c *IoTThingsGraph) GetSystemTemplateWithContext(ctx aws.Context, input *GetSystemTemplateInput, opts ...request.Option) (*GetSystemTemplateOutput, error)

GetSystemTemplateWithContext is the same as GetSystemTemplate with the addition of the ability to pass a context and additional request options.

See GetSystemTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetUploadStatus deprecated 

func (c *IoTThingsGraph) GetUploadStatus(input *GetUploadStatusInput) (*GetUploadStatusOutput, error)

GetUploadStatus API operation for AWS IoT Things Graph.

Gets the status of the specified upload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation GetUploadStatus for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetUploadStatusRequest deprecated 

func (c *IoTThingsGraph) GetUploadStatusRequest(input *GetUploadStatusInput) (req *request.Request, output *GetUploadStatusOutput)

GetUploadStatusRequest generates a "aws/request.Request" representing the client's request for the GetUploadStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetUploadStatus for more information on using the GetUploadStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetUploadStatusRequest method.
req, resp := client.GetUploadStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) GetUploadStatusWithContext deprecated 

func (c *IoTThingsGraph) GetUploadStatusWithContext(ctx aws.Context, input *GetUploadStatusInput, opts ...request.Option) (*GetUploadStatusOutput, error)

GetUploadStatusWithContext is the same as GetUploadStatus with the addition of the ability to pass a context and additional request options.

See GetUploadStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListFlowExecutionMessages deprecated 

func (c *IoTThingsGraph) ListFlowExecutionMessages(input *ListFlowExecutionMessagesInput) (*ListFlowExecutionMessagesOutput, error)

ListFlowExecutionMessages API operation for AWS IoT Things Graph.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation ListFlowExecutionMessages for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListFlowExecutionMessagesPages deprecated 

func (c *IoTThingsGraph) ListFlowExecutionMessagesPages(input *ListFlowExecutionMessagesInput, fn func(*ListFlowExecutionMessagesOutput, bool) bool) error

ListFlowExecutionMessagesPages iterates over the pages of a ListFlowExecutionMessages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFlowExecutionMessages method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListFlowExecutionMessages operation.
pageNum := 0
err := client.ListFlowExecutionMessagesPages(params,
    func(page *iotthingsgraph.ListFlowExecutionMessagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListFlowExecutionMessagesPagesWithContext deprecated 

func (c *IoTThingsGraph) ListFlowExecutionMessagesPagesWithContext(ctx aws.Context, input *ListFlowExecutionMessagesInput, fn func(*ListFlowExecutionMessagesOutput, bool) bool, opts ...request.Option) error

ListFlowExecutionMessagesPagesWithContext same as ListFlowExecutionMessagesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListFlowExecutionMessagesRequest deprecated 

func (c *IoTThingsGraph) ListFlowExecutionMessagesRequest(input *ListFlowExecutionMessagesInput) (req *request.Request, output *ListFlowExecutionMessagesOutput)

ListFlowExecutionMessagesRequest generates a "aws/request.Request" representing the client's request for the ListFlowExecutionMessages operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFlowExecutionMessages for more information on using the ListFlowExecutionMessages API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFlowExecutionMessagesRequest method.
req, resp := client.ListFlowExecutionMessagesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListFlowExecutionMessagesWithContext deprecated 

func (c *IoTThingsGraph) ListFlowExecutionMessagesWithContext(ctx aws.Context, input *ListFlowExecutionMessagesInput, opts ...request.Option) (*ListFlowExecutionMessagesOutput, error)

ListFlowExecutionMessagesWithContext is the same as ListFlowExecutionMessages with the addition of the ability to pass a context and additional request options.

See ListFlowExecutionMessages for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListTagsForResource deprecated 

func (c *IoTThingsGraph) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT Things Graph.

Lists all tags on an AWS IoT Things Graph resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListTagsForResourcePages deprecated 

func (c *IoTThingsGraph) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *iotthingsgraph.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListTagsForResourcePagesWithContext deprecated 

func (c *IoTThingsGraph) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListTagsForResourceRequest deprecated 

func (c *IoTThingsGraph) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) ListTagsForResourceWithContext deprecated 

func (c *IoTThingsGraph) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchEntities deprecated 

func (c *IoTThingsGraph) SearchEntities(input *SearchEntitiesInput) (*SearchEntitiesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchEntities for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchEntitiesPages deprecated 

func (c *IoTThingsGraph) SearchEntitiesPages(input *SearchEntitiesInput, fn func(*SearchEntitiesOutput, bool) bool) error

SearchEntitiesPages iterates over the pages of a SearchEntities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchEntities method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchEntities operation.
pageNum := 0
err := client.SearchEntitiesPages(params,
    func(page *iotthingsgraph.SearchEntitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchEntitiesPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchEntitiesPagesWithContext(ctx aws.Context, input *SearchEntitiesInput, fn func(*SearchEntitiesOutput, bool) bool, opts ...request.Option) error

SearchEntitiesPagesWithContext same as SearchEntitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchEntitiesRequest deprecated 

func (c *IoTThingsGraph) SearchEntitiesRequest(input *SearchEntitiesInput) (req *request.Request, output *SearchEntitiesOutput)

SearchEntitiesRequest generates a "aws/request.Request" representing the client's request for the SearchEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchEntities for more information on using the SearchEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchEntitiesRequest method.
req, resp := client.SearchEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchEntitiesWithContext deprecated 

func (c *IoTThingsGraph) SearchEntitiesWithContext(ctx aws.Context, input *SearchEntitiesInput, opts ...request.Option) (*SearchEntitiesOutput, error)

SearchEntitiesWithContext is the same as SearchEntities with the addition of the ability to pass a context and additional request options.

See SearchEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowExecutions deprecated 

func (c *IoTThingsGraph) SearchFlowExecutions(input *SearchFlowExecutionsInput) (*SearchFlowExecutionsOutput, error)

SearchFlowExecutions API operation for AWS IoT Things Graph.

Searches for AWS IoT Things Graph workflow execution instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchFlowExecutions for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowExecutionsPages deprecated 

func (c *IoTThingsGraph) SearchFlowExecutionsPages(input *SearchFlowExecutionsInput, fn func(*SearchFlowExecutionsOutput, bool) bool) error

SearchFlowExecutionsPages iterates over the pages of a SearchFlowExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchFlowExecutions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchFlowExecutions operation.
pageNum := 0
err := client.SearchFlowExecutionsPages(params,
    func(page *iotthingsgraph.SearchFlowExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowExecutionsPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchFlowExecutionsPagesWithContext(ctx aws.Context, input *SearchFlowExecutionsInput, fn func(*SearchFlowExecutionsOutput, bool) bool, opts ...request.Option) error

SearchFlowExecutionsPagesWithContext same as SearchFlowExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowExecutionsRequest deprecated 

func (c *IoTThingsGraph) SearchFlowExecutionsRequest(input *SearchFlowExecutionsInput) (req *request.Request, output *SearchFlowExecutionsOutput)

SearchFlowExecutionsRequest generates a "aws/request.Request" representing the client's request for the SearchFlowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchFlowExecutions for more information on using the SearchFlowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchFlowExecutionsRequest method.
req, resp := client.SearchFlowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowExecutionsWithContext deprecated 

func (c *IoTThingsGraph) SearchFlowExecutionsWithContext(ctx aws.Context, input *SearchFlowExecutionsInput, opts ...request.Option) (*SearchFlowExecutionsOutput, error)

SearchFlowExecutionsWithContext is the same as SearchFlowExecutions with the addition of the ability to pass a context and additional request options.

See SearchFlowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowTemplates deprecated 

func (c *IoTThingsGraph) SearchFlowTemplates(input *SearchFlowTemplatesInput) (*SearchFlowTemplatesOutput, error)

SearchFlowTemplates API operation for AWS IoT Things Graph.

Searches for summary information about workflows.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchFlowTemplates for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowTemplatesPages deprecated 

func (c *IoTThingsGraph) SearchFlowTemplatesPages(input *SearchFlowTemplatesInput, fn func(*SearchFlowTemplatesOutput, bool) bool) error

SearchFlowTemplatesPages iterates over the pages of a SearchFlowTemplates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchFlowTemplates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchFlowTemplates operation.
pageNum := 0
err := client.SearchFlowTemplatesPages(params,
    func(page *iotthingsgraph.SearchFlowTemplatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowTemplatesPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchFlowTemplatesPagesWithContext(ctx aws.Context, input *SearchFlowTemplatesInput, fn func(*SearchFlowTemplatesOutput, bool) bool, opts ...request.Option) error

SearchFlowTemplatesPagesWithContext same as SearchFlowTemplatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowTemplatesRequest deprecated 

func (c *IoTThingsGraph) SearchFlowTemplatesRequest(input *SearchFlowTemplatesInput) (req *request.Request, output *SearchFlowTemplatesOutput)

SearchFlowTemplatesRequest generates a "aws/request.Request" representing the client's request for the SearchFlowTemplates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchFlowTemplates for more information on using the SearchFlowTemplates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchFlowTemplatesRequest method.
req, resp := client.SearchFlowTemplatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchFlowTemplatesWithContext deprecated 

func (c *IoTThingsGraph) SearchFlowTemplatesWithContext(ctx aws.Context, input *SearchFlowTemplatesInput, opts ...request.Option) (*SearchFlowTemplatesOutput, error)

SearchFlowTemplatesWithContext is the same as SearchFlowTemplates with the addition of the ability to pass a context and additional request options.

See SearchFlowTemplates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemInstances deprecated 

func (c *IoTThingsGraph) SearchSystemInstances(input *SearchSystemInstancesInput) (*SearchSystemInstancesOutput, error)

SearchSystemInstances API operation for AWS IoT Things Graph.

Searches for system instances in the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchSystemInstances for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemInstancesPages deprecated 

func (c *IoTThingsGraph) SearchSystemInstancesPages(input *SearchSystemInstancesInput, fn func(*SearchSystemInstancesOutput, bool) bool) error

SearchSystemInstancesPages iterates over the pages of a SearchSystemInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchSystemInstances method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchSystemInstances operation.
pageNum := 0
err := client.SearchSystemInstancesPages(params,
    func(page *iotthingsgraph.SearchSystemInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemInstancesPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchSystemInstancesPagesWithContext(ctx aws.Context, input *SearchSystemInstancesInput, fn func(*SearchSystemInstancesOutput, bool) bool, opts ...request.Option) error

SearchSystemInstancesPagesWithContext same as SearchSystemInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemInstancesRequest deprecated 

func (c *IoTThingsGraph) SearchSystemInstancesRequest(input *SearchSystemInstancesInput) (req *request.Request, output *SearchSystemInstancesOutput)

SearchSystemInstancesRequest generates a "aws/request.Request" representing the client's request for the SearchSystemInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchSystemInstances for more information on using the SearchSystemInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchSystemInstancesRequest method.
req, resp := client.SearchSystemInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemInstancesWithContext deprecated 

func (c *IoTThingsGraph) SearchSystemInstancesWithContext(ctx aws.Context, input *SearchSystemInstancesInput, opts ...request.Option) (*SearchSystemInstancesOutput, error)

SearchSystemInstancesWithContext is the same as SearchSystemInstances with the addition of the ability to pass a context and additional request options.

See SearchSystemInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemTemplates deprecated 

func (c *IoTThingsGraph) SearchSystemTemplates(input *SearchSystemTemplatesInput) (*SearchSystemTemplatesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchSystemTemplates for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemTemplatesPages deprecated 

func (c *IoTThingsGraph) SearchSystemTemplatesPages(input *SearchSystemTemplatesInput, fn func(*SearchSystemTemplatesOutput, bool) bool) error

SearchSystemTemplatesPages iterates over the pages of a SearchSystemTemplates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchSystemTemplates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchSystemTemplates operation.
pageNum := 0
err := client.SearchSystemTemplatesPages(params,
    func(page *iotthingsgraph.SearchSystemTemplatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemTemplatesPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchSystemTemplatesPagesWithContext(ctx aws.Context, input *SearchSystemTemplatesInput, fn func(*SearchSystemTemplatesOutput, bool) bool, opts ...request.Option) error

SearchSystemTemplatesPagesWithContext same as SearchSystemTemplatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemTemplatesRequest deprecated 

func (c *IoTThingsGraph) SearchSystemTemplatesRequest(input *SearchSystemTemplatesInput) (req *request.Request, output *SearchSystemTemplatesOutput)

SearchSystemTemplatesRequest generates a "aws/request.Request" representing the client's request for the SearchSystemTemplates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchSystemTemplates for more information on using the SearchSystemTemplates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchSystemTemplatesRequest method.
req, resp := client.SearchSystemTemplatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchSystemTemplatesWithContext deprecated 

func (c *IoTThingsGraph) SearchSystemTemplatesWithContext(ctx aws.Context, input *SearchSystemTemplatesInput, opts ...request.Option) (*SearchSystemTemplatesOutput, error)

SearchSystemTemplatesWithContext is the same as SearchSystemTemplates with the addition of the ability to pass a context and additional request options.

See SearchSystemTemplates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchThings deprecated 

func (c *IoTThingsGraph) SearchThings(input *SearchThingsInput) (*SearchThingsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation SearchThings for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchThingsPages deprecated 

func (c *IoTThingsGraph) SearchThingsPages(input *SearchThingsInput, fn func(*SearchThingsOutput, bool) bool) error

SearchThingsPages iterates over the pages of a SearchThings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See SearchThings method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a SearchThings operation.
pageNum := 0
err := client.SearchThingsPages(params,
    func(page *iotthingsgraph.SearchThingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchThingsPagesWithContext deprecated 

func (c *IoTThingsGraph) SearchThingsPagesWithContext(ctx aws.Context, input *SearchThingsInput, fn func(*SearchThingsOutput, bool) bool, opts ...request.Option) error

SearchThingsPagesWithContext same as SearchThingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchThingsRequest deprecated 

func (c *IoTThingsGraph) SearchThingsRequest(input *SearchThingsInput) (req *request.Request, output *SearchThingsOutput)

SearchThingsRequest generates a "aws/request.Request" representing the client's request for the SearchThings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SearchThings for more information on using the SearchThings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SearchThingsRequest method.
req, resp := client.SearchThingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) SearchThingsWithContext deprecated 

func (c *IoTThingsGraph) SearchThingsWithContext(ctx aws.Context, input *SearchThingsInput, opts ...request.Option) (*SearchThingsOutput, error)

SearchThingsWithContext is the same as SearchThings with the addition of the ability to pass a context and additional request options.

See SearchThings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) TagResource deprecated 

func (c *IoTThingsGraph) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT Things Graph.

Creates a tag for the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation TagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) TagResourceRequest deprecated 

func (c *IoTThingsGraph) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) TagResourceWithContext deprecated 

func (c *IoTThingsGraph) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UndeploySystemInstance deprecated 

func (c *IoTThingsGraph) UndeploySystemInstance(input *UndeploySystemInstanceInput) (*UndeploySystemInstanceOutput, error)

UndeploySystemInstance API operation for AWS IoT Things Graph.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation UndeploySystemInstance for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ThrottlingException

  • InternalFailureException

  • ResourceNotFoundException

  • ResourceInUseException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UndeploySystemInstanceRequest deprecated 

func (c *IoTThingsGraph) UndeploySystemInstanceRequest(input *UndeploySystemInstanceInput) (req *request.Request, output *UndeploySystemInstanceOutput)

UndeploySystemInstanceRequest generates a "aws/request.Request" representing the client's request for the UndeploySystemInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UndeploySystemInstance for more information on using the UndeploySystemInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UndeploySystemInstanceRequest method.
req, resp := client.UndeploySystemInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UndeploySystemInstanceWithContext deprecated 

func (c *IoTThingsGraph) UndeploySystemInstanceWithContext(ctx aws.Context, input *UndeploySystemInstanceInput, opts ...request.Option) (*UndeploySystemInstanceOutput, error)

UndeploySystemInstanceWithContext is the same as UndeploySystemInstance with the addition of the ability to pass a context and additional request options.

See UndeploySystemInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UntagResource deprecated 

func (c *IoTThingsGraph) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT Things Graph.

Removes a tag from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation UntagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceAlreadyExistsException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UntagResourceRequest deprecated 

func (c *IoTThingsGraph) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UntagResourceWithContext deprecated 

func (c *IoTThingsGraph) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateFlowTemplate deprecated 

func (c *IoTThingsGraph) UpdateFlowTemplate(input *UpdateFlowTemplateInput) (*UpdateFlowTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation UpdateFlowTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateFlowTemplateRequest deprecated 

func (c *IoTThingsGraph) UpdateFlowTemplateRequest(input *UpdateFlowTemplateInput) (req *request.Request, output *UpdateFlowTemplateOutput)

UpdateFlowTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateFlowTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFlowTemplate for more information on using the UpdateFlowTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateFlowTemplateRequest method.
req, resp := client.UpdateFlowTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateFlowTemplateWithContext deprecated 

func (c *IoTThingsGraph) UpdateFlowTemplateWithContext(ctx aws.Context, input *UpdateFlowTemplateInput, opts ...request.Option) (*UpdateFlowTemplateOutput, error)

UpdateFlowTemplateWithContext is the same as UpdateFlowTemplate with the addition of the ability to pass a context and additional request options.

See UpdateFlowTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateSystemTemplate deprecated 

func (c *IoTThingsGraph) UpdateSystemTemplate(input *UpdateSystemTemplateInput) (*UpdateSystemTemplateOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation UpdateSystemTemplate for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • ResourceNotFoundException

  • ThrottlingException

  • InternalFailureException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateSystemTemplateRequest deprecated 

func (c *IoTThingsGraph) UpdateSystemTemplateRequest(input *UpdateSystemTemplateInput) (req *request.Request, output *UpdateSystemTemplateOutput)

UpdateSystemTemplateRequest generates a "aws/request.Request" representing the client's request for the UpdateSystemTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSystemTemplate for more information on using the UpdateSystemTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSystemTemplateRequest method.
req, resp := client.UpdateSystemTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UpdateSystemTemplateWithContext deprecated 

func (c *IoTThingsGraph) UpdateSystemTemplateWithContext(ctx aws.Context, input *UpdateSystemTemplateInput, opts ...request.Option) (*UpdateSystemTemplateOutput, error)

UpdateSystemTemplateWithContext is the same as UpdateSystemTemplate with the addition of the ability to pass a context and additional request options.

See UpdateSystemTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UploadEntityDefinitions deprecated 

func (c *IoTThingsGraph) UploadEntityDefinitions(input *UploadEntityDefinitionsInput) (*UploadEntityDefinitionsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Things Graph's API operation UploadEntityDefinitions for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • InternalFailureException

  • ThrottlingException

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UploadEntityDefinitionsRequest deprecated 

func (c *IoTThingsGraph) UploadEntityDefinitionsRequest(input *UploadEntityDefinitionsInput) (req *request.Request, output *UploadEntityDefinitionsOutput)

UploadEntityDefinitionsRequest generates a "aws/request.Request" representing the client's request for the UploadEntityDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UploadEntityDefinitions for more information on using the UploadEntityDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UploadEntityDefinitionsRequest method.
req, resp := client.UploadEntityDefinitionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

Deprecated: since: 2022-08-30

func (*IoTThingsGraph) UploadEntityDefinitionsWithContext deprecated 

func (c *IoTThingsGraph) UploadEntityDefinitionsWithContext(ctx aws.Context, input *UploadEntityDefinitionsInput, opts ...request.Option) (*UploadEntityDefinitionsOutput, error)

UploadEntityDefinitionsWithContext is the same as UploadEntityDefinitions with the addition of the ability to pass a context and additional request options.

See UploadEntityDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: since: 2022-08-30

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListFlowExecutionMessagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFlowExecutionMessagesInput) SetFlowExecutionId 

func (s *ListFlowExecutionMessagesInput) SetFlowExecutionId(v string) *ListFlowExecutionMessagesInput

SetFlowExecutionId sets the FlowExecutionId field's value.

func (*ListFlowExecutionMessagesInput) SetMaxResults 

func (s *ListFlowExecutionMessagesInput) SetMaxResults(v int64) *ListFlowExecutionMessagesInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlowExecutionMessagesInput) SetNextToken 

func (s *ListFlowExecutionMessagesInput) SetNextToken(v string) *ListFlowExecutionMessagesInput

SetNextToken sets the NextToken field's value.

func (ListFlowExecutionMessagesInput) String 

func (s ListFlowExecutionMessagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListFlowExecutionMessagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFlowExecutionMessagesOutput) SetMessages 

func (s *ListFlowExecutionMessagesOutput) SetMessages(v []*FlowExecutionMessage) *ListFlowExecutionMessagesOutput

SetMessages sets the Messages field's value.

func (*ListFlowExecutionMessagesOutput) SetNextToken 

func (s *ListFlowExecutionMessagesOutput) SetNextToken(v string) *ListFlowExecutionMessagesOutput

SetNextToken sets the NextToken field's value.

func (ListFlowExecutionMessagesOutput) String 

func (s ListFlowExecutionMessagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults 

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s MetricsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricsConfiguration) SetCloudMetricEnabled 

func (s *MetricsConfiguration) SetCloudMetricEnabled(v bool) *MetricsConfiguration

SetCloudMetricEnabled sets the CloudMetricEnabled field's value.

func (*MetricsConfiguration) SetMetricRuleRoleArn 

func (s *MetricsConfiguration) SetMetricRuleRoleArn(v string) *MetricsConfiguration

SetMetricRuleRoleArn sets the MetricRuleRoleArn field's value.

func (MetricsConfiguration) String 

func (s MetricsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricsConfiguration) Validate 

func (s *MetricsConfiguration) Validate() error

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

type ResourceAlreadyExistsException added in v1.28.0 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.28.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchEntitiesInput 

type SearchEntitiesInput struct {

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

	// 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) GoString 

func (s SearchEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchEntitiesInput) SetEntityTypes 

func (s *SearchEntitiesInput) SetEntityTypes(v []*string) *SearchEntitiesInput

SetEntityTypes sets the EntityTypes field's value.

func (*SearchEntitiesInput) SetFilters 

func (s *SearchEntitiesInput) SetFilters(v []*EntityFilter) *SearchEntitiesInput

SetFilters sets the Filters field's value.

func (*SearchEntitiesInput) SetMaxResults 

func (s *SearchEntitiesInput) SetMaxResults(v int64) *SearchEntitiesInput

SetMaxResults sets the MaxResults field's value.

func (*SearchEntitiesInput) SetNamespaceVersion 

func (s *SearchEntitiesInput) SetNamespaceVersion(v int64) *SearchEntitiesInput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (*SearchEntitiesInput) SetNextToken 

func (s *SearchEntitiesInput) SetNextToken(v string) *SearchEntitiesInput

SetNextToken sets the NextToken field's value.

func (SearchEntitiesInput) String 

func (s SearchEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchEntitiesOutput) SetDescriptions 

func (s *SearchEntitiesOutput) SetDescriptions(v []*EntityDescription) *SearchEntitiesOutput

SetDescriptions sets the Descriptions field's value.

func (*SearchEntitiesOutput) SetNextToken 

func (s *SearchEntitiesOutput) SetNextToken(v string) *SearchEntitiesOutput

SetNextToken sets the NextToken field's value.

func (SearchEntitiesOutput) String 

func (s SearchEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchFlowExecutionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFlowExecutionsInput) SetEndTime 

func (s *SearchFlowExecutionsInput) SetEndTime(v time.Time) *SearchFlowExecutionsInput

SetEndTime sets the EndTime field's value.

func (*SearchFlowExecutionsInput) SetFlowExecutionId 

func (s *SearchFlowExecutionsInput) SetFlowExecutionId(v string) *SearchFlowExecutionsInput

SetFlowExecutionId sets the FlowExecutionId field's value.

func (*SearchFlowExecutionsInput) SetMaxResults 

func (s *SearchFlowExecutionsInput) SetMaxResults(v int64) *SearchFlowExecutionsInput

SetMaxResults sets the MaxResults field's value.

func (*SearchFlowExecutionsInput) SetNextToken 

func (s *SearchFlowExecutionsInput) SetNextToken(v string) *SearchFlowExecutionsInput

SetNextToken sets the NextToken field's value.

func (*SearchFlowExecutionsInput) SetStartTime 

func (s *SearchFlowExecutionsInput) SetStartTime(v time.Time) *SearchFlowExecutionsInput

SetStartTime sets the StartTime field's value.

func (*SearchFlowExecutionsInput) SetSystemInstanceId 

func (s *SearchFlowExecutionsInput) SetSystemInstanceId(v string) *SearchFlowExecutionsInput

SetSystemInstanceId sets the SystemInstanceId field's value.

func (SearchFlowExecutionsInput) String 

func (s SearchFlowExecutionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchFlowExecutionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFlowExecutionsOutput) SetNextToken 

func (s *SearchFlowExecutionsOutput) SetNextToken(v string) *SearchFlowExecutionsOutput

SetNextToken sets the NextToken field's value.

func (*SearchFlowExecutionsOutput) SetSummaries 

func (s *SearchFlowExecutionsOutput) SetSummaries(v []*FlowExecutionSummary) *SearchFlowExecutionsOutput

SetSummaries sets the Summaries field's value.

func (SearchFlowExecutionsOutput) String 

func (s SearchFlowExecutionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchFlowTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFlowTemplatesInput) SetFilters 

func (s *SearchFlowTemplatesInput) SetFilters(v []*FlowTemplateFilter) *SearchFlowTemplatesInput

SetFilters sets the Filters field's value.

func (*SearchFlowTemplatesInput) SetMaxResults 

func (s *SearchFlowTemplatesInput) SetMaxResults(v int64) *SearchFlowTemplatesInput

SetMaxResults sets the MaxResults field's value.

func (*SearchFlowTemplatesInput) SetNextToken 

func (s *SearchFlowTemplatesInput) SetNextToken(v string) *SearchFlowTemplatesInput

SetNextToken sets the NextToken field's value.

func (SearchFlowTemplatesInput) String 

func (s SearchFlowTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchFlowTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchFlowTemplatesOutput) SetNextToken 

func (s *SearchFlowTemplatesOutput) SetNextToken(v string) *SearchFlowTemplatesOutput

SetNextToken sets the NextToken field's value.

func (*SearchFlowTemplatesOutput) SetSummaries 

func (s *SearchFlowTemplatesOutput) SetSummaries(v []*FlowTemplateSummary) *SearchFlowTemplatesOutput

SetSummaries sets the Summaries field's value.

func (SearchFlowTemplatesOutput) String 

func (s SearchFlowTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchSystemInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSystemInstancesInput) SetFilters 

func (s *SearchSystemInstancesInput) SetFilters(v []*SystemInstanceFilter) *SearchSystemInstancesInput

SetFilters sets the Filters field's value.

func (*SearchSystemInstancesInput) SetMaxResults 

func (s *SearchSystemInstancesInput) SetMaxResults(v int64) *SearchSystemInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*SearchSystemInstancesInput) SetNextToken 

func (s *SearchSystemInstancesInput) SetNextToken(v string) *SearchSystemInstancesInput

SetNextToken sets the NextToken field's value.

func (SearchSystemInstancesInput) String 

func (s SearchSystemInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchSystemInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSystemInstancesOutput) SetNextToken 

func (s *SearchSystemInstancesOutput) SetNextToken(v string) *SearchSystemInstancesOutput

SetNextToken sets the NextToken field's value.

func (*SearchSystemInstancesOutput) SetSummaries 

func (s *SearchSystemInstancesOutput) SetSummaries(v []*SystemInstanceSummary) *SearchSystemInstancesOutput

SetSummaries sets the Summaries field's value.

func (SearchSystemInstancesOutput) String 

func (s SearchSystemInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchSystemTemplatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSystemTemplatesInput) SetFilters 

func (s *SearchSystemTemplatesInput) SetFilters(v []*SystemTemplateFilter) *SearchSystemTemplatesInput

SetFilters sets the Filters field's value.

func (*SearchSystemTemplatesInput) SetMaxResults 

func (s *SearchSystemTemplatesInput) SetMaxResults(v int64) *SearchSystemTemplatesInput

SetMaxResults sets the MaxResults field's value.

func (*SearchSystemTemplatesInput) SetNextToken 

func (s *SearchSystemTemplatesInput) SetNextToken(v string) *SearchSystemTemplatesInput

SetNextToken sets the NextToken field's value.

func (SearchSystemTemplatesInput) String 

func (s SearchSystemTemplatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchSystemTemplatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchSystemTemplatesOutput) SetNextToken 

func (s *SearchSystemTemplatesOutput) SetNextToken(v string) *SearchSystemTemplatesOutput

SetNextToken sets the NextToken field's value.

func (*SearchSystemTemplatesOutput) SetSummaries 

func (s *SearchSystemTemplatesOutput) SetSummaries(v []*SystemTemplateSummary) *SearchSystemTemplatesOutput

SetSummaries sets the Summaries field's value.

func (SearchSystemTemplatesOutput) String 

func (s SearchSystemTemplatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchThingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchThingsInput) SetEntityId 

func (s *SearchThingsInput) SetEntityId(v string) *SearchThingsInput

SetEntityId sets the EntityId field's value.

func (*SearchThingsInput) SetMaxResults 

func (s *SearchThingsInput) SetMaxResults(v int64) *SearchThingsInput

SetMaxResults sets the MaxResults field's value.

func (*SearchThingsInput) SetNamespaceVersion 

func (s *SearchThingsInput) SetNamespaceVersion(v int64) *SearchThingsInput

SetNamespaceVersion sets the NamespaceVersion field's value.

func (*SearchThingsInput) SetNextToken 

func (s *SearchThingsInput) SetNextToken(v string) *SearchThingsInput

SetNextToken sets the NextToken field's value.

func (SearchThingsInput) String 

func (s SearchThingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SearchThingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchThingsOutput) SetNextToken 

func (s *SearchThingsOutput) SetNextToken(v string) *SearchThingsOutput

SetNextToken sets the NextToken field's value.

func (*SearchThingsOutput) SetThings 

func (s *SearchThingsOutput) SetThings(v []*Thing) *SearchThingsOutput

SetThings sets the Things field's value.

func (SearchThingsOutput) String 

func (s SearchThingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SystemInstanceDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemInstanceDescription) SetDefinition 

func (s *SystemInstanceDescription) SetDefinition(v *DefinitionDocument) *SystemInstanceDescription

SetDefinition sets the Definition field's value.

func (*SystemInstanceDescription) SetFlowActionsRoleArn 

func (s *SystemInstanceDescription) SetFlowActionsRoleArn(v string) *SystemInstanceDescription

SetFlowActionsRoleArn sets the FlowActionsRoleArn field's value.

func (*SystemInstanceDescription) SetMetricsConfiguration 

func (s *SystemInstanceDescription) SetMetricsConfiguration(v *MetricsConfiguration) *SystemInstanceDescription

SetMetricsConfiguration sets the MetricsConfiguration field's value.

func (*SystemInstanceDescription) SetS3BucketName 

func (s *SystemInstanceDescription) SetS3BucketName(v string) *SystemInstanceDescription

SetS3BucketName sets the S3BucketName field's value.

func (*SystemInstanceDescription) SetSummary 

func (s *SystemInstanceDescription) SetSummary(v *SystemInstanceSummary) *SystemInstanceDescription

SetSummary sets the Summary field's value.

func (*SystemInstanceDescription) SetValidatedDependencyRevisions 

func (s *SystemInstanceDescription) SetValidatedDependencyRevisions(v []*DependencyRevision) *SystemInstanceDescription

SetValidatedDependencyRevisions sets the ValidatedDependencyRevisions field's value.

func (*SystemInstanceDescription) SetValidatedNamespaceVersion 

func (s *SystemInstanceDescription) SetValidatedNamespaceVersion(v int64) *SystemInstanceDescription

SetValidatedNamespaceVersion sets the ValidatedNamespaceVersion field's value.

func (SystemInstanceDescription) String 

func (s SystemInstanceDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SystemInstanceFilter 

type SystemInstanceFilter struct {

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

	// 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) GoString 

func (s SystemInstanceFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemInstanceFilter) SetName 

func (s *SystemInstanceFilter) SetName(v string) *SystemInstanceFilter

SetName sets the Name field's value.

func (*SystemInstanceFilter) SetValue 

func (s *SystemInstanceFilter) SetValue(v []*string) *SystemInstanceFilter

SetValue sets the Value field's value.

func (SystemInstanceFilter) String 

func (s SystemInstanceFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"status" type:"string" enum:"SystemInstanceDeploymentStatus"`

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

	// 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) GoString 

func (s SystemInstanceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemInstanceSummary) SetArn 

func (s *SystemInstanceSummary) SetArn(v string) *SystemInstanceSummary

SetArn sets the Arn field's value.

func (*SystemInstanceSummary) SetCreatedAt 

func (s *SystemInstanceSummary) SetCreatedAt(v time.Time) *SystemInstanceSummary

SetCreatedAt sets the CreatedAt field's value.

func (*SystemInstanceSummary) SetGreengrassGroupId 

func (s *SystemInstanceSummary) SetGreengrassGroupId(v string) *SystemInstanceSummary

SetGreengrassGroupId sets the GreengrassGroupId field's value.

func (*SystemInstanceSummary) SetGreengrassGroupName 

func (s *SystemInstanceSummary) SetGreengrassGroupName(v string) *SystemInstanceSummary

SetGreengrassGroupName sets the GreengrassGroupName field's value.

func (*SystemInstanceSummary) SetGreengrassGroupVersionId 

func (s *SystemInstanceSummary) SetGreengrassGroupVersionId(v string) *SystemInstanceSummary

SetGreengrassGroupVersionId sets the GreengrassGroupVersionId field's value.

func (*SystemInstanceSummary) SetId 

func (s *SystemInstanceSummary) SetId(v string) *SystemInstanceSummary

SetId sets the Id field's value.

func (*SystemInstanceSummary) SetStatus 

func (s *SystemInstanceSummary) SetStatus(v string) *SystemInstanceSummary

SetStatus sets the Status field's value.

func (*SystemInstanceSummary) SetTarget 

func (s *SystemInstanceSummary) SetTarget(v string) *SystemInstanceSummary

SetTarget sets the Target field's value.

func (*SystemInstanceSummary) SetUpdatedAt 

func (s *SystemInstanceSummary) SetUpdatedAt(v time.Time) *SystemInstanceSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (SystemInstanceSummary) String 

func (s SystemInstanceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SystemTemplateDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemTemplateDescription) SetDefinition 

func (s *SystemTemplateDescription) SetDefinition(v *DefinitionDocument) *SystemTemplateDescription

SetDefinition sets the Definition field's value.

func (*SystemTemplateDescription) SetSummary 

func (s *SystemTemplateDescription) SetSummary(v *SystemTemplateSummary) *SystemTemplateDescription

SetSummary sets the Summary field's value.

func (*SystemTemplateDescription) SetValidatedNamespaceVersion 

func (s *SystemTemplateDescription) SetValidatedNamespaceVersion(v int64) *SystemTemplateDescription

SetValidatedNamespaceVersion sets the ValidatedNamespaceVersion field's value.

func (SystemTemplateDescription) String 

func (s SystemTemplateDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SystemTemplateFilter 

type SystemTemplateFilter struct {

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

	// 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) GoString 

func (s SystemTemplateFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemTemplateFilter) SetName 

func (s *SystemTemplateFilter) SetName(v string) *SystemTemplateFilter

SetName sets the Name field's value.

func (*SystemTemplateFilter) SetValue 

func (s *SystemTemplateFilter) SetValue(v []*string) *SystemTemplateFilter

SetValue sets the Value field's value.

func (SystemTemplateFilter) String 

func (s SystemTemplateFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemTemplateFilter) Validate 

func (s *SystemTemplateFilter) Validate() error

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

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

func (s SystemTemplateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemTemplateSummary) SetArn 

func (s *SystemTemplateSummary) SetArn(v string) *SystemTemplateSummary

SetArn sets the Arn field's value.

func (*SystemTemplateSummary) SetCreatedAt 

func (s *SystemTemplateSummary) SetCreatedAt(v time.Time) *SystemTemplateSummary

SetCreatedAt sets the CreatedAt field's value.

func (*SystemTemplateSummary) SetId 

func (s *SystemTemplateSummary) SetId(v string) *SystemTemplateSummary

SetId sets the Id field's value.

func (*SystemTemplateSummary) SetRevisionNumber 

func (s *SystemTemplateSummary) SetRevisionNumber(v int64) *SystemTemplateSummary

SetRevisionNumber sets the RevisionNumber field's value.

func (SystemTemplateSummary) String 

func (s SystemTemplateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Thing) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Thing) SetThingArn 

func (s *Thing) SetThingArn(v string) *Thing

SetThingArn sets the ThingArn field's value.

func (*Thing) SetThingName 

func (s *Thing) SetThingName(v string) *Thing

SetThingName sets the ThingName field's value.

func (Thing) String 

func (s Thing) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UndeploySystemInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UndeploySystemInstanceInput) SetId 

func (s *UndeploySystemInstanceInput) SetId(v string) *UndeploySystemInstanceInput

SetId sets the Id field's value.

func (UndeploySystemInstanceInput) String 

func (s UndeploySystemInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UndeploySystemInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UndeploySystemInstanceOutput) SetSummary 

func (s *UndeploySystemInstanceOutput) SetSummary(v *SystemInstanceSummary) *UndeploySystemInstanceOutput

SetSummary sets the Summary field's value.

func (UndeploySystemInstanceOutput) String 

func (s UndeploySystemInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateFlowTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFlowTemplateInput) SetCompatibleNamespaceVersion 

func (s *UpdateFlowTemplateInput) SetCompatibleNamespaceVersion(v int64) *UpdateFlowTemplateInput

SetCompatibleNamespaceVersion sets the CompatibleNamespaceVersion field's value.

func (*UpdateFlowTemplateInput) SetDefinition 

func (s *UpdateFlowTemplateInput) SetDefinition(v *DefinitionDocument) *UpdateFlowTemplateInput

SetDefinition sets the Definition field's value.

func (*UpdateFlowTemplateInput) SetId 

func (s *UpdateFlowTemplateInput) SetId(v string) *UpdateFlowTemplateInput

SetId sets the Id field's value.

func (UpdateFlowTemplateInput) String 

func (s UpdateFlowTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateFlowTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFlowTemplateOutput) SetSummary 

func (s *UpdateFlowTemplateOutput) SetSummary(v *FlowTemplateSummary) *UpdateFlowTemplateOutput

SetSummary sets the Summary field's value.

func (UpdateFlowTemplateOutput) String 

func (s UpdateFlowTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateSystemTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSystemTemplateInput) SetCompatibleNamespaceVersion 

func (s *UpdateSystemTemplateInput) SetCompatibleNamespaceVersion(v int64) *UpdateSystemTemplateInput

SetCompatibleNamespaceVersion sets the CompatibleNamespaceVersion field's value.

func (*UpdateSystemTemplateInput) SetDefinition 

func (s *UpdateSystemTemplateInput) SetDefinition(v *DefinitionDocument) *UpdateSystemTemplateInput

SetDefinition sets the Definition field's value.

func (*UpdateSystemTemplateInput) SetId 

func (s *UpdateSystemTemplateInput) SetId(v string) *UpdateSystemTemplateInput

SetId sets the Id field's value.

func (UpdateSystemTemplateInput) String 

func (s UpdateSystemTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateSystemTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSystemTemplateOutput) SetSummary 

func (s *UpdateSystemTemplateOutput) SetSummary(v *SystemTemplateSummary) *UpdateSystemTemplateOutput

SetSummary sets the Summary field's value.

func (UpdateSystemTemplateOutput) String 

func (s UpdateSystemTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UploadEntityDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UploadEntityDefinitionsInput) SetDeprecateExistingEntities 

func (s *UploadEntityDefinitionsInput) SetDeprecateExistingEntities(v bool) *UploadEntityDefinitionsInput

SetDeprecateExistingEntities sets the DeprecateExistingEntities field's value.

func (*UploadEntityDefinitionsInput) SetDocument 

func (s *UploadEntityDefinitionsInput) SetDocument(v *DefinitionDocument) *UploadEntityDefinitionsInput

SetDocument sets the Document field's value.

func (*UploadEntityDefinitionsInput) SetSyncWithPublicNamespace 

func (s *UploadEntityDefinitionsInput) SetSyncWithPublicNamespace(v bool) *UploadEntityDefinitionsInput

SetSyncWithPublicNamespace sets the SyncWithPublicNamespace field's value.

func (UploadEntityDefinitionsInput) String 

func (s UploadEntityDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UploadEntityDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UploadEntityDefinitionsOutput) SetUploadId 

func (s *UploadEntityDefinitionsOutput) SetUploadId(v string) *UploadEntityDefinitionsOutput

SetUploadId sets the UploadId field's value.

func (UploadEntityDefinitionsOutput) String 

func (s UploadEntityDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.