package types

import "github.com/aws/aws-sdk-go-v2/service/iotthingsgraph/types"

Index

Types

type DefinitionDocument

type DefinitionDocument struct {

	// The language used to define the entity. GRAPHQL is the only valid value.
	//
	// This member is required.
	Language DefinitionLanguage

	// The GraphQL text that defines the entity.
	//
	// This member is required.
	Text *string
}

A document that defines an entity.

type DefinitionLanguage

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

Enum values for DefinitionLanguage

type DependencyRevision

type DependencyRevision struct {

	// The ID of the workflow or system.
	Id *string

	// The revision number of the workflow or system.
	RevisionNumber *int64
}

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

type DeploymentTarget

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

Enum values for DeploymentTarget

type EntityDescription

type EntityDescription struct {

	// The entity ID.
	Id *string

	// The entity ARN.
	Arn *string

	// The time at which the entity was created.
	CreatedAt *time.Time

	// The entity type.
	Type EntityType

	// The definition document of the entity.
	Definition *DefinitionDocument
}

Describes the properties of an entity.

type EntityFilter

type EntityFilter struct {

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []*string

	// The name of the entity search filter field. REFERENCED_ENTITY_ID filters on
	// entities that are used by the entity in the result set. For example, you can
	// filter on the ID of a property that is used in a state.
	Name EntityFilterName
}

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.

type EntityFilterName

type EntityFilterName string
const (
	EntityFilterNameName                 EntityFilterName = "NAME"
	EntityFilterNameNamespace            EntityFilterName = "NAMESPACE"
	EntityFilterNameSemantic_type_path   EntityFilterName = "SEMANTIC_TYPE_PATH"
	EntityFilterNameReferenced_entity_id EntityFilterName = "REFERENCED_ENTITY_ID"
)

Enum values for EntityFilterName

type EntityType

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

Enum values for EntityType

type FlowExecutionEventType

type FlowExecutionEventType string
const (
	FlowExecutionEventTypeExecution_started              FlowExecutionEventType = "EXECUTION_STARTED"
	FlowExecutionEventTypeExecution_failed               FlowExecutionEventType = "EXECUTION_FAILED"
	FlowExecutionEventTypeExecution_aborted              FlowExecutionEventType = "EXECUTION_ABORTED"
	FlowExecutionEventTypeExecution_succeeded            FlowExecutionEventType = "EXECUTION_SUCCEEDED"
	FlowExecutionEventTypeStep_started                   FlowExecutionEventType = "STEP_STARTED"
	FlowExecutionEventTypeStep_failed                    FlowExecutionEventType = "STEP_FAILED"
	FlowExecutionEventTypeStep_succeeded                 FlowExecutionEventType = "STEP_SUCCEEDED"
	FlowExecutionEventTypeActivity_scheduled             FlowExecutionEventType = "ACTIVITY_SCHEDULED"
	FlowExecutionEventTypeActivity_started               FlowExecutionEventType = "ACTIVITY_STARTED"
	FlowExecutionEventTypeActivity_failed                FlowExecutionEventType = "ACTIVITY_FAILED"
	FlowExecutionEventTypeActivity_succeeded             FlowExecutionEventType = "ACTIVITY_SUCCEEDED"
	FlowExecutionEventTypeStart_flow_execution_task      FlowExecutionEventType = "START_FLOW_EXECUTION_TASK"
	FlowExecutionEventTypeSchedule_next_ready_steps_task FlowExecutionEventType = "SCHEDULE_NEXT_READY_STEPS_TASK"
	FlowExecutionEventTypeThing_action_task              FlowExecutionEventType = "THING_ACTION_TASK"
	FlowExecutionEventTypeThing_action_task_failed       FlowExecutionEventType = "THING_ACTION_TASK_FAILED"
	FlowExecutionEventTypeThing_action_task_succeeded    FlowExecutionEventType = "THING_ACTION_TASK_SUCCEEDED"
	FlowExecutionEventTypeAcknowledge_task_message       FlowExecutionEventType = "ACKNOWLEDGE_TASK_MESSAGE"
)

Enum values for FlowExecutionEventType

type FlowExecutionMessage

type FlowExecutionMessage struct {

	// The type of flow event .
	EventType FlowExecutionEventType

	// The unique identifier of the message.
	MessageId *string

	// A string containing information about the flow event.
	Payload *string

	// The date and time when the message was last updated.
	Timestamp *time.Time
}

An object that contains information about a flow event.

type FlowExecutionStatus

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

Enum values for FlowExecutionStatus

type FlowExecutionSummary

type FlowExecutionSummary struct {

	// The ID of the flow.
	FlowTemplateId *string

	// The date and time when the flow execution summary was last updated.
	UpdatedAt *time.Time

	// The date and time when the flow execution summary was created.
	CreatedAt *time.Time

	// The ID of the flow execution.
	FlowExecutionId *string

	// The ID of the system instance that contains the flow.
	SystemInstanceId *string

	// The current status of the flow execution.
	Status FlowExecutionStatus
}

An object that contains summary information about a flow execution.

type FlowTemplateDescription

type FlowTemplateDescription struct {

	// A workflow's definition document.
	Definition *DefinitionDocument

	// The version of the user's namespace against which the workflow was validated.
	// Use this value in your system instance.
	ValidatedNamespaceVersion *int64

	// An object that contains summary information about a workflow.
	Summary *FlowTemplateSummary
}

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

type FlowTemplateFilter

type FlowTemplateFilter struct {

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	//
	// This member is required.
	Value []*string

	// The name of the search filter field.
	//
	// This member is required.
	Name FlowTemplateFilterName
}

An object that filters a workflow search.

type FlowTemplateFilterName

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

Enum values for FlowTemplateFilterName

type FlowTemplateSummary

type FlowTemplateSummary struct {

	// The date when the workflow was created.
	CreatedAt *time.Time

	// The revision number of the workflow.
	RevisionNumber *int64

	// The ID of the workflow.
	Id *string

	// The ARN of the workflow.
	Arn *string
}

An object that contains summary information about a workflow.

type InternalFailureException

type InternalFailureException struct {
	Message *string
}

func (*InternalFailureException) Error

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault

func (e *InternalFailureException) ErrorFault() smithy.ErrorFault

func (*InternalFailureException) ErrorMessage

func (e *InternalFailureException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
}

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

type LimitExceededException

type LimitExceededException struct {
	Message *string
}

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

type MetricsConfiguration

type MetricsConfiguration struct {

	// The ARN of the role that is used to collect cloud metrics.
	MetricRuleRoleArn *string

	// A Boolean that specifies whether cloud metrics are collected.
	CloudMetricEnabled *bool
}

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

type NamespaceDeletionStatus

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

Enum values for NamespaceDeletionStatus

type NamespaceDeletionStatusErrorCodes

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

Enum values for NamespaceDeletionStatusErrorCodes

type ResourceAlreadyExistsException

type ResourceAlreadyExistsException struct {
	Message *string
}

func (*ResourceAlreadyExistsException) Error

func (*ResourceAlreadyExistsException) ErrorCode

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceInUseException

type ResourceInUseException struct {
	Message *string
}

func (*ResourceInUseException) Error

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type SystemInstanceDeploymentStatus

type SystemInstanceDeploymentStatus string
const (
	SystemInstanceDeploymentStatusNot_deployed         SystemInstanceDeploymentStatus = "NOT_DEPLOYED"
	SystemInstanceDeploymentStatusBootstrap            SystemInstanceDeploymentStatus = "BOOTSTRAP"
	SystemInstanceDeploymentStatusDeploy_in_progress   SystemInstanceDeploymentStatus = "DEPLOY_IN_PROGRESS"
	SystemInstanceDeploymentStatusDeployed_in_target   SystemInstanceDeploymentStatus = "DEPLOYED_IN_TARGET"
	SystemInstanceDeploymentStatusUndeploy_in_progress SystemInstanceDeploymentStatus = "UNDEPLOY_IN_PROGRESS"
	SystemInstanceDeploymentStatusFailed               SystemInstanceDeploymentStatus = "FAILED"
	SystemInstanceDeploymentStatusPending_delete       SystemInstanceDeploymentStatus = "PENDING_DELETE"
	SystemInstanceDeploymentStatusDeleted_in_target    SystemInstanceDeploymentStatus = "DELETED_IN_TARGET"
)

Enum values for SystemInstanceDeploymentStatus

type SystemInstanceDescription

type SystemInstanceDescription struct {

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

	// The Amazon Simple Storage Service bucket where information about a system
	// instance is stored.
	S3BucketName *string

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

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

	// The version of the user's namespace against which the system instance was
	// validated.
	ValidatedNamespaceVersion *int64

	// An object that contains summary information about a system instance.
	Summary *SystemInstanceSummary

	// A document that defines an entity.
	Definition *DefinitionDocument
}

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

type SystemInstanceFilter

type SystemInstanceFilter struct {

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []*string

	// The name of the search filter field.
	Name SystemInstanceFilterName
}

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.

type SystemInstanceFilterName

type SystemInstanceFilterName string
const (
	SystemInstanceFilterNameSystem_template_id    SystemInstanceFilterName = "SYSTEM_TEMPLATE_ID"
	SystemInstanceFilterNameStatus                SystemInstanceFilterName = "STATUS"
	SystemInstanceFilterNameGreengrass_group_name SystemInstanceFilterName = "GREENGRASS_GROUP_NAME"
)

Enum values for SystemInstanceFilterName

type SystemInstanceSummary

type SystemInstanceSummary struct {

	// The ID of the Greengrass group where the system instance is deployed.
	GreengrassGroupId *string

	// The date when the system instance was created.
	CreatedAt *time.Time

	// The version of the Greengrass group where the system instance is deployed.
	GreengrassGroupVersionId *string

	// The ARN of the system instance.
	Arn *string

	// The date and time when the system instance was last updated.</p>
	UpdatedAt *time.Time

	// The status of the system instance.
	Status SystemInstanceDeploymentStatus

	// The ID of the system instance.
	Id *string

	// The target of the system instance.
	Target DeploymentTarget

	// The ID of the Greengrass group where the system instance is deployed.
	GreengrassGroupName *string
}

An object that contains summary information about a system instance.

type SystemTemplateDescription

type SystemTemplateDescription struct {

	// The namespace version against which the system was validated. Use this value in
	// your system instance.
	ValidatedNamespaceVersion *int64

	// The definition document of a system.
	Definition *DefinitionDocument

	// An object that contains summary information about a system.
	Summary *SystemTemplateSummary
}

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

type SystemTemplateFilter

type SystemTemplateFilter struct {

	// The name of the system search filter field.
	//
	// This member is required.
	Name SystemTemplateFilterName

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	//
	// This member is required.
	Value []*string
}

An object that filters a system search.

type SystemTemplateFilterName

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

Enum values for SystemTemplateFilterName

type SystemTemplateSummary

type SystemTemplateSummary struct {

	// The revision number of the system.
	RevisionNumber *int64

	// The ID of the system.
	Id *string

	// The ARN of the system.
	Arn *string

	// The date when the system was created.
	CreatedAt *time.Time
}

An object that contains information about a system.

type Tag

type Tag struct {

	// The optional value of the tag. The string value can be from 1 to 256 Unicode
	// characters in length.
	//
	// This member is required.
	Value *string

	// The required name of the tag. The string value can be from 1 to 128 Unicode
	// characters in length.
	//
	// This member is required.
	Key *string
}

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

type Thing

type Thing struct {

	// The name of the thing.
	ThingName *string

	// The ARN of the thing.
	ThingArn *string
}

An AWS IoT thing.

type ThrottlingException

type ThrottlingException struct {
	Message *string
}

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type UploadStatus

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

Enum values for UploadStatus

Source Files

enums.go errors.go types.go

Version
v0.26.0
Published
Oct 1, 2020
Platform
windows/amd64
Imports
3 packages
Last checked
3 hours ago

Tools for package owners.