types

package
v1.21.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
	// contains filtered or unexported fields
}

A document that defines an entity.

type DefinitionLanguage 

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

Enum values for DefinitionLanguage

func (DefinitionLanguage) Values added in v0.29.0 

func (DefinitionLanguage) Values() []DefinitionLanguage

Values returns all known values for DefinitionLanguage. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DependencyRevision 

type DependencyRevision struct {

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

	// The revision number of the workflow or system.
	RevisionNumber *int64
	// 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.

type DeploymentTarget 

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

Enum values for DeploymentTarget

func (DeploymentTarget) Values added in v0.29.0 

func (DeploymentTarget) Values() []DeploymentTarget

Values returns all known values for DeploymentTarget. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntityDescription 

type EntityDescription struct {

	// The entity ARN.
	Arn *string

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

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

	// The entity ID.
	Id *string

	// The entity type.
	Type EntityType
	// contains filtered or unexported fields
}

Describes the properties of an entity.

type EntityFilter 

type EntityFilter struct {

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

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []string
	// 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 .

type EntityFilterName 

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

Enum values for EntityFilterName

func (EntityFilterName) Values added in v0.29.0 

func (EntityFilterName) Values() []EntityFilterName

Values returns all known values for EntityFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntityType 

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

Enum values for EntityType

func (EntityType) Values added in v0.29.0 

func (EntityType) Values() []EntityType

Values returns all known values for EntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FlowExecutionEventType 

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

Enum values for FlowExecutionEventType

func (FlowExecutionEventType) Values added in v0.29.0 

func (FlowExecutionEventType) Values() []FlowExecutionEventType

Values returns all known values for FlowExecutionEventType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

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

func (FlowExecutionStatus) Values added in v0.29.0 

func (FlowExecutionStatus) Values() []FlowExecutionStatus

Values returns all known values for FlowExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FlowExecutionSummary 

type FlowExecutionSummary struct {

	// 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 flow.
	FlowTemplateId *string

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

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

	// The date and time when the flow execution summary was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

An object that contains summary information about a flow execution.

type FlowTemplateDescription 

type FlowTemplateDescription struct {

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

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

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

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

type FlowTemplateFilter 

type FlowTemplateFilter struct {

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

	// 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
	// contains filtered or unexported fields
}

An object that filters a workflow search.

type FlowTemplateFilterName 

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

Enum values for FlowTemplateFilterName

func (FlowTemplateFilterName) Values added in v0.29.0 

func (FlowTemplateFilterName) Values() []FlowTemplateFilterName

Values returns all known values for FlowTemplateFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FlowTemplateSummary 

type FlowTemplateSummary struct {

	// The ARN of the workflow.
	Arn *string

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

	// The ID of the workflow.
	Id *string

	// The revision number of the workflow.
	RevisionNumber *int64
	// contains filtered or unexported fields
}

An object that contains summary information about a workflow.

type InternalFailureException 

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 {

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

	// The ARN of the role that is used to collect cloud metrics.
	MetricRuleRoleArn *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.

type NamespaceDeletionStatus 

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

Enum values for NamespaceDeletionStatus

func (NamespaceDeletionStatus) Values added in v0.29.0 

func (NamespaceDeletionStatus) Values() []NamespaceDeletionStatus

Values returns all known values for NamespaceDeletionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NamespaceDeletionStatusErrorCodes 

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

Enum values for NamespaceDeletionStatusErrorCodes

func (NamespaceDeletionStatusErrorCodes) Values added in v0.29.0 

func (NamespaceDeletionStatusErrorCodes) Values() []NamespaceDeletionStatusErrorCodes

Values returns all known values for NamespaceDeletionStatusErrorCodes. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

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

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

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

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type SystemInstanceDeploymentStatus 

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

Enum values for SystemInstanceDeploymentStatus

func (SystemInstanceDeploymentStatus) Values added in v0.29.0 

func (SystemInstanceDeploymentStatus) Values() []SystemInstanceDeploymentStatus

Values returns all known values for SystemInstanceDeploymentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SystemInstanceDescription 

type SystemInstanceDescription struct {

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

	// 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 Amazon Simple Storage Service bucket where information about a system
	// instance is stored.
	S3BucketName *string

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

	// 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 version of the user's namespace against which the system instance was
	// validated.
	ValidatedNamespaceVersion *int64
	// contains filtered or unexported fields
}

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

type SystemInstanceFilter 

type SystemInstanceFilter struct {

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

	// An array of string values for the search filter field. Multiple values function
	// as AND criteria in the search.
	Value []string
	// 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.

type SystemInstanceFilterName 

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

Enum values for SystemInstanceFilterName

func (SystemInstanceFilterName) Values added in v0.29.0 

func (SystemInstanceFilterName) Values() []SystemInstanceFilterName

Values returns all known values for SystemInstanceFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SystemInstanceSummary 

type SystemInstanceSummary struct {

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

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

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

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

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

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

	// The status of the system instance.
	Status SystemInstanceDeploymentStatus

	// The target of the system instance.
	Target DeploymentTarget

	// The date and time when the system instance was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

An object that contains summary information about a system instance.

type SystemTemplateDescription 

type SystemTemplateDescription struct {

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

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

	// The namespace version against which the system was validated. Use this value in
	// your system instance.
	ValidatedNamespaceVersion *int64
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

An object that filters a system search.

type SystemTemplateFilterName 

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

Enum values for SystemTemplateFilterName

func (SystemTemplateFilterName) Values added in v0.29.0 

func (SystemTemplateFilterName) Values() []SystemTemplateFilterName

Values returns all known values for SystemTemplateFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SystemTemplateSummary 

type SystemTemplateSummary struct {

	// The ARN of the system.
	Arn *string

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

	// The ID of the system.
	Id *string

	// The revision number of the system.
	RevisionNumber *int64
	// contains filtered or unexported fields
}

An object that contains information about a system.

type Tag 

type Tag struct {

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

	// 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
	// contains filtered or unexported fields
}

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

type Thing 

type Thing struct {

	// The ARN of the thing.
	ThingArn *string

	// The name of the thing.
	ThingName *string
	// contains filtered or unexported fields
}

An AWS IoT thing.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 (
	UploadStatusInProgress UploadStatus = "IN_PROGRESS"
	UploadStatusSucceeded  UploadStatus = "SUCCEEDED"
	UploadStatusFailed     UploadStatus = "FAILED"
)

Enum values for UploadStatus

func (UploadStatus) Values added in v0.29.0 

func (UploadStatus) Values() []UploadStatus

Values returns all known values for UploadStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

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.